« blib/lib/Paws/EC2/CreateRouteTableResult.pm
↑ Summary
blib/lib/Paws/EC2/CreateSpotDatafeedSubscription.pm »
| 1 | |||
| 2 | package Paws::EC2::CreateSnapshot; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Description => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 6 | 1 | has OutpostArn => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | |
| 8 | 1 | has VolumeId => (is => 'ro', isa => 'Str', required => 1); | |
| 9 | |||
| 10 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 11 | |||
| 12 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSnapshot'); | |
| 13 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::Snapshot'); | |
| 14 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 15 | 1 | 1; | |
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::CreateSnapshot - Arguments for method CreateSnapshot on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateSnapshot on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateSnapshot. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSnapshot. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | # To create a snapshot | ||
| 35 | # This example creates a snapshot of the volume with a volume ID of | ||
| 36 | # ``vol-1234567890abcdef0`` and a short description to identify the snapshot. | ||
| 37 | my $Snapshot = $ec2->CreateSnapshot( | ||
| 38 | 'Description' => 'This is my root volume snapshot.', | ||
| 39 | 'VolumeId' => 'vol-1234567890abcdef0' | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Description = $Snapshot->Description; | ||
| 44 | my $OwnerId = $Snapshot->OwnerId; | ||
| 45 | my $SnapshotId = $Snapshot->SnapshotId; | ||
| 46 | my $StartTime = $Snapshot->StartTime; | ||
| 47 | my $State = $Snapshot->State; | ||
| 48 | my $Tags = $Snapshot->Tags; | ||
| 49 | my $VolumeId = $Snapshot->VolumeId; | ||
| 50 | my $VolumeSize = $Snapshot->VolumeSize; | ||
| 51 | |||
| 52 | # Returns a L<Paws::EC2::Snapshot> object. | ||
| 53 | |||
| 54 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateSnapshot> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Description => Str | ||
| 61 | |||
| 62 | A description for the snapshot. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 DryRun => Bool | ||
| 67 | |||
| 68 | Checks whether you have the required permissions for the action, | ||
| 69 | without actually making the request, and provides an error response. If | ||
| 70 | you have the required permissions, the error response is | ||
| 71 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 OutpostArn => Str | ||
| 76 | |||
| 77 | The Amazon Resource Name (ARN) of the AWS Outpost on which to create a | ||
| 78 | local snapshot. | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | To create a snapshot of a volume in a Region, omit this parameter. The | ||
| 85 | snapshot is created in the same Region as the volume. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | To create a snapshot of a volume on an Outpost and store the snapshot | ||
| 90 | in the Region, omit this parameter. The snapshot is created in the | ||
| 91 | Region for the Outpost. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | To create a snapshot of a volume on an Outpost and store the snapshot | ||
| 96 | on an Outpost, specify the ARN of the destination Outpost. The snapshot | ||
| 97 | must be created on the same Outpost as the volume. | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | For more information, see Creating local snapshots from volumes on an | ||
| 102 | Outpost | ||
| 103 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-snapshot) | ||
| 104 | in the I<Amazon Elastic Compute Cloud User Guide>. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 109 | |||
| 110 | The tags to apply to the snapshot during creation. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> VolumeId => Str | ||
| 115 | |||
| 116 | The ID of the EBS volume. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateSnapshot in L<Paws::EC2> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 | |||