File Coverage

blib/lib/Paws/EC2/CopyImage.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::CopyImage;
3 1     1   468 use Moose;
  1         2  
  1         6  
4             has ClientToken => (is => 'ro', isa => 'Str');
5             has Description => (is => 'ro', isa => 'Str');
6             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
7             has Encrypted => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'encrypted' );
8             has KmsKeyId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kmsKeyId' );
9             has Name => (is => 'ro', isa => 'Str', required => 1);
10             has SourceImageId => (is => 'ro', isa => 'Str', required => 1);
11             has SourceRegion => (is => 'ro', isa => 'Str', required => 1);
12              
13 1     1   6038 use MooseX::ClassAttribute;
  1         3  
  1         9  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyImage');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CopyImageResult');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::EC2::CopyImage - Arguments for method CopyImage on Paws::EC2
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method CopyImage on the
29             Amazon Elastic Compute Cloud service. Use the attributes of this class
30             as arguments to method CopyImage.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyImage.
33              
34             As an example:
35              
36             $service_obj->CopyImage(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 ClientToken => Str
44              
45             Unique, case-sensitive identifier you provide to ensure idempotency of
46             the request. For more information, see How to Ensure Idempotency in the
47             I<Amazon Elastic Compute Cloud User Guide>.
48              
49              
50              
51             =head2 Description => Str
52              
53             A description for the new AMI in the destination region.
54              
55              
56              
57             =head2 DryRun => Bool
58              
59             Checks whether you have the required permissions for the action,
60             without actually making the request, and provides an error response. If
61             you have the required permissions, the error response is
62             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
63              
64              
65              
66             =head2 Encrypted => Bool
67              
68             Specifies whether the destination snapshots of the copied image should
69             be encrypted. The default CMK for EBS is used unless a non-default AWS
70             Key Management Service (AWS KMS) CMK is specified with C<KmsKeyId>. For
71             more information, see Amazon EBS Encryption in the I<Amazon Elastic
72             Compute Cloud User Guide>.
73              
74              
75              
76             =head2 KmsKeyId => Str
77              
78             The full ARN of the AWS Key Management Service (AWS KMS) CMK to use
79             when encrypting the snapshots of an image during a copy operation. This
80             parameter is only required if you want to use a non-default CMK; if
81             this parameter is not specified, the default CMK for EBS is used. The
82             ARN contains the C<arn:aws:kms> namespace, followed by the region of
83             the CMK, the AWS account ID of the CMK owner, the C<key> namespace, and
84             then the CMK ID. For example,
85             arn:aws:kms:I<us-east-1>:I<012345678910>:key/I<abcd1234-a123-456a-a12b-a123b4cd56ef>.
86             The specified CMK must exist in the region that the snapshot is being
87             copied to. If a C<KmsKeyId> is specified, the C<Encrypted> flag must
88             also be set.
89              
90              
91              
92             =head2 B<REQUIRED> Name => Str
93              
94             The name of the new AMI in the destination region.
95              
96              
97              
98             =head2 B<REQUIRED> SourceImageId => Str
99              
100             The ID of the AMI to copy.
101              
102              
103              
104             =head2 B<REQUIRED> SourceRegion => Str
105              
106             The name of the region that contains the AMI to copy.
107              
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, documenting arguments for method CopyImage in L<Paws::EC2>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122