« blib/lib/Paws/EC2/CreateSecurityGroupResult.pm
↑ Summary
blib/lib/Paws/EC2/CreateSnapshotsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::CreateSnapshots; | ||
| 3 | use Moose; | ||
| 4 | has CopyTagsFromSource => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 7 | has InstanceSpecification => (is => 'ro', isa => 'Paws::EC2::InstanceSpecification', required => 1); | ||
| 8 | has OutpostArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSnapshots'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateSnapshotsResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EC2::CreateSnapshots - Arguments for method CreateSnapshots on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateSnapshots on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateSnapshots. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSnapshots. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | my $CreateSnapshotsResult = $ec2->CreateSnapshots( | ||
| 36 | InstanceSpecification => { | ||
| 37 | ExcludeBootVolume => 1, # OPTIONAL | ||
| 38 | InstanceId => 'MyInstanceId', # OPTIONAL | ||
| 39 | }, | ||
| 40 | CopyTagsFromSource => 'volume', # OPTIONAL | ||
| 41 | Description => 'MyString', # OPTIONAL | ||
| 42 | DryRun => 1, # OPTIONAL | ||
| 43 | OutpostArn => 'MyString', # OPTIONAL | ||
| 44 | TagSpecifications => [ | ||
| 45 | { | ||
| 46 | ResourceType => 'client-vpn-endpoint' | ||
| 47 | , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL | ||
| 48 | Tags => [ | ||
| 49 | { | ||
| 50 | Key => 'MyString', | ||
| 51 | Value => 'MyString', | ||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | }, | ||
| 56 | ... | ||
| 57 | ], # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $Snapshots = $CreateSnapshotsResult->Snapshots; | ||
| 62 | |||
| 63 | # Returns a L<Paws::EC2::CreateSnapshotsResult> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateSnapshots> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 CopyTagsFromSource => Str | ||
| 72 | |||
| 73 | Copies the tags from the specified volume to corresponding snapshot. | ||
| 74 | |||
| 75 | Valid values are: C<"volume"> | ||
| 76 | |||
| 77 | =head2 Description => Str | ||
| 78 | |||
| 79 | A description propagated to every snapshot specified by the instance. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 DryRun => Bool | ||
| 84 | |||
| 85 | Checks whether you have the required permissions for the action, | ||
| 86 | without actually making the request, and provides an error response. If | ||
| 87 | you have the required permissions, the error response is | ||
| 88 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> InstanceSpecification => L<Paws::EC2::InstanceSpecification> | ||
| 93 | |||
| 94 | The instance to specify which volumes should be included in the | ||
| 95 | snapshots. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 OutpostArn => Str | ||
| 100 | |||
| 101 | The Amazon Resource Name (ARN) of the AWS Outpost on which to create | ||
| 102 | the local snapshots. | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | To create snapshots from an instance in a Region, omit this parameter. | ||
| 109 | The snapshots are created in the same Region as the instance. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | To create snapshots from an instance on an Outpost and store the | ||
| 114 | snapshots in the Region, omit this parameter. The snapshots are created | ||
| 115 | in the Region for the Outpost. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | To create snapshots from an instance on an Outpost and store the | ||
| 120 | snapshots on an Outpost, specify the ARN of the destination Outpost. | ||
| 121 | The snapshots must be created on the same Outpost as the instance. | ||
| 122 | |||
| 123 | =back | ||
| 124 | |||
| 125 | For more information, see Creating multi-volume local snapshots from | ||
| 126 | instances on an Outpost | ||
| 127 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#create-multivol-snapshot) | ||
| 128 | in the I<Amazon Elastic Compute Cloud User Guide>. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 133 | |||
| 134 | Tags to apply to every snapshot specified by the instance. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head1 SEE ALSO | ||
| 140 | |||
| 141 | This class forms part of L<Paws>, documenting arguments for method CreateSnapshots in L<Paws::EC2> | ||
| 142 | |||
| 143 | =head1 BUGS and CONTRIBUTIONS | ||
| 144 | |||
| 145 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 146 | |||
| 147 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 148 | |||
| 149 | =cut | ||
| 150 |