blib/lib/Paws/EC2/RegisterImage.pm

filter: Statementstmt 100% 24 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 26 / 26 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/Region.pm ↑ Summary blib/lib/Paws/EC2/RegisterImageResult.pm »
1  
2 package Paws::EC2::RegisterImage;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has Architecture => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'architecture' );
5 1 has BillingProducts => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'BillingProduct' );
6 1 has BlockDeviceMappings => (is => 'ro', isa => 'ArrayRef[Paws::EC2::BlockDeviceMapping]', traits => ['NameInRequest'], request_name => 'BlockDeviceMapping' );
7 1 has BootMode => (is => 'ro', isa => 'Str');
8 1 has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' );
9 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
10 1 has EnaSupport => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enaSupport' );
11 1 has ImageLocation => (is => 'ro', isa => 'Str');
12 1 has KernelId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'kernelId' );
13 1 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1);
14 1 has RamdiskId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ramdiskId' );
15 1 has RootDeviceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'rootDeviceName' );
16 1 has SriovNetSupport => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sriovNetSupport' );
17 1 has VirtualizationType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'virtualizationType' );
18  
19 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
20  
21 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterImage');
22 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::RegisterImageResult');
23 1 class_has _result_key => (isa => 'Str', is => 'ro');
24 1 1;
25  
26 ### main pod documentation begin ###
27  
28 =head1 NAME
29  
30 Paws::EC2::RegisterImage - Arguments for method RegisterImage on L<Paws::EC2>
31  
32 =head1 DESCRIPTION
33  
34 This class represents the parameters used for calling the method RegisterImage on the
35 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
36 as arguments to method RegisterImage.
37  
38 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterImage.
39  
40 =head1 SYNOPSIS
41  
42 my $ec2 = Paws->service('EC2');
43 my $RegisterImageResult = $ec2->RegisterImage(
44 Name => 'MyString',
45 Architecture => 'i386', # OPTIONAL
46 BillingProducts => [ 'MyString', ... ], # OPTIONAL
47 BlockDeviceMappings => [
48 {
49 DeviceName => 'MyString',
50 Ebs => {
51 DeleteOnTermination => 1, # OPTIONAL
52 Encrypted => 1, # OPTIONAL
53 Iops => 1, # OPTIONAL
54 KmsKeyId => 'MyString',
55 OutpostArn => 'MyString',
56 SnapshotId => 'MyString',
57 Throughput => 1, # OPTIONAL
58 VolumeSize => 1, # OPTIONAL
59 VolumeType => 'standard'
60 , # values: standard, io1, io2, gp2, sc1, st1, gp3; OPTIONAL
61 }, # OPTIONAL
62 NoDevice => 'MyString',
63 VirtualName => 'MyString',
64 },
65 ...
66 ], # OPTIONAL
67 BootMode => 'legacy-bios', # OPTIONAL
68 Description => 'MyString', # OPTIONAL
69 DryRun => 1, # OPTIONAL
70 EnaSupport => 1, # OPTIONAL
71 ImageLocation => 'MyString', # OPTIONAL
72 KernelId => 'MyKernelId', # OPTIONAL
73 RamdiskId => 'MyRamdiskId', # OPTIONAL
74 RootDeviceName => 'MyString', # OPTIONAL
75 SriovNetSupport => 'MyString', # OPTIONAL
76 VirtualizationType => 'MyString', # OPTIONAL
77 );
78  
79 # Results:
80 my $ImageId = $RegisterImageResult->ImageId;
81  
82 # Returns a L<Paws::EC2::RegisterImageResult> object.
83  
84 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.
85 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/RegisterImage>
86  
87 =head1 ATTRIBUTES
88  
89  
90 =head2 Architecture => Str
91  
92 The architecture of the AMI.
93  
94 Default: For Amazon EBS-backed AMIs, C<i386>. For instance store-backed
95 AMIs, the architecture specified in the manifest file.
96  
97 Valid values are: C<"i386">, C<"x86_64">, C<"arm64">
98  
99 =head2 BillingProducts => ArrayRef[Str|Undef]
100  
101 The billing product codes. Your account must be authorized to specify
102 billing product codes. Otherwise, you can use the AWS Marketplace to
103 bill for the use of an AMI.
104  
105  
106  
107 =head2 BlockDeviceMappings => ArrayRef[L<Paws::EC2::BlockDeviceMapping>]
108  
109 The block device mapping entries.
110  
111 If you specify an EBS volume using the ID of an EBS snapshot, you can't
112 specify the encryption state of the volume.
113  
114 If you create an AMI on an Outpost, then all backing snapshots must be
115 on the same Outpost or in the Region of that Outpost. AMIs on an
116 Outpost that include local snapshots can be used to launch instances on
117 the same Outpost only. For more information, Amazon EBS local snapshots
118 on Outposts
119 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami)
120 in the I<Amazon Elastic Compute Cloud User Guide>.
121  
122  
123  
124 =head2 BootMode => Str
125  
126 The boot mode of the AMI. For more information, see Boot modes
127 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in
128 the I<Amazon Elastic Compute Cloud User Guide>.
129  
130 Valid values are: C<"legacy-bios">, C<"uefi">
131  
132 =head2 Description => Str
133  
134 A description for your AMI.
135  
136  
137  
138 =head2 DryRun => Bool
139  
140 Checks whether you have the required permissions for the action,
141 without actually making the request, and provides an error response. If
142 you have the required permissions, the error response is
143 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
144  
145  
146  
147 =head2 EnaSupport => Bool
148  
149 Set to C<true> to enable enhanced networking with ENA for the AMI and
150 any instances that you launch from the AMI.
151  
152 This option is supported only for HVM AMIs. Specifying this option with
153 a PV AMI can make instances launched from the AMI unreachable.
154  
155  
156  
157 =head2 ImageLocation => Str
158  
159 The full path to your AMI manifest in Amazon S3 storage. The specified
160 bucket must have the C<aws-exec-read> canned access control list (ACL)
161 to ensure that it can be accessed by Amazon EC2. For more information,
162 see Canned ACLs
163 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
164 in the I<Amazon S3 Service Developer Guide>.
165  
166  
167  
168 =head2 KernelId => Str
169  
170 The ID of the kernel.
171  
172  
173  
174 =head2 B<REQUIRED> Name => Str
175  
176 A name for your AMI.
177  
178 Constraints: 3-128 alphanumeric characters, parentheses (()), square
179 brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single
180 quotes ('), at-signs (@), or underscores(_)
181  
182  
183  
184 =head2 RamdiskId => Str
185  
186 The ID of the RAM disk.
187  
188  
189  
190 =head2 RootDeviceName => Str
191  
192 The device name of the root device volume (for example, C</dev/sda1>).
193  
194  
195  
196 =head2 SriovNetSupport => Str
197  
198 Set to C<simple> to enable enhanced networking with the Intel 82599
199 Virtual Function interface for the AMI and any instances that you
200 launch from the AMI.
201  
202 There is no way to disable C<sriovNetSupport> at this time.
203  
204 This option is supported only for HVM AMIs. Specifying this option with
205 a PV AMI can make instances launched from the AMI unreachable.
206  
207  
208  
209 =head2 VirtualizationType => Str
210  
211 The type of virtualization (C<hvm> | C<paravirtual>).
212  
213 Default: C<paravirtual>
214  
215  
216  
217  
218 =head1 SEE ALSO
219  
220 This class forms part of L<Paws>, documenting arguments for method RegisterImage in L<Paws::EC2>
221  
222 =head1 BUGS and CONTRIBUTIONS
223  
224 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
225  
226 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
227  
228 =cut
229  
« blib/lib/Paws/EC2/Region.pm ↑ Summary blib/lib/Paws/EC2/RegisterImageResult.pm »