NAME
Paws::EC2::RegisterImage - Arguments for method RegisterImage on Paws::EC2
DESCRIPTION
This class represents the parameters used for calling the method RegisterImage on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method RegisterImage.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterImage.
SYNOPSIS
my $ec2 = Paws->service('EC2');
my $RegisterImageResult = $ec2->RegisterImage(
Name => 'MyString',
Architecture => 'i386', # OPTIONAL
BillingProducts => [ 'MyString', ... ], # OPTIONAL
BlockDeviceMappings => [
{
DeviceName => 'MyString',
Ebs => {
DeleteOnTermination => 1, # OPTIONAL
Encrypted => 1, # OPTIONAL
Iops => 1, # OPTIONAL
KmsKeyId => 'MyString',
OutpostArn => 'MyString',
SnapshotId => 'MyString',
Throughput => 1, # OPTIONAL
VolumeSize => 1, # OPTIONAL
VolumeType => 'standard'
, # values: standard, io1, io2, gp2, sc1, st1, gp3; OPTIONAL
}, # OPTIONAL
NoDevice => 'MyString',
VirtualName => 'MyString',
},
...
], # OPTIONAL
BootMode => 'legacy-bios', # OPTIONAL
Description => 'MyString', # OPTIONAL
DryRun => 1, # OPTIONAL
EnaSupport => 1, # OPTIONAL
ImageLocation => 'MyString', # OPTIONAL
KernelId => 'MyKernelId', # OPTIONAL
RamdiskId => 'MyRamdiskId', # OPTIONAL
RootDeviceName => 'MyString', # OPTIONAL
SriovNetSupport => 'MyString', # OPTIONAL
VirtualizationType => 'MyString', # OPTIONAL
);
# Results:
my $ImageId = $RegisterImageResult->ImageId;
# Returns a L<Paws::EC2::RegisterImageResult> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/RegisterImage
ATTRIBUTES
Architecture => Str
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386
. For instance store-backed AMIs, the architecture specified in the manifest file.
Valid values are: "i386"
, "x86_64"
, "arm64"
BillingProducts => ArrayRef[Str|Undef]
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.
BlockDeviceMappings => ArrayRef[Paws::EC2::BlockDeviceMapping]
The block device mapping entries.
If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami) in the Amazon Elastic Compute Cloud User Guide.
BootMode => Str
The boot mode of the AMI. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the Amazon Elastic Compute Cloud User Guide.
Valid values are: "legacy-bios"
, "uefi"
Description => Str
A description for your AMI.
DryRun => Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
EnaSupport => Bool
Set to true
to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
ImageLocation => Str
The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read
canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the Amazon S3 Service Developer Guide.
KernelId => Str
The ID of the kernel.
REQUIRED Name => Str
A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
RamdiskId => Str
The ID of the RAM disk.
RootDeviceName => Str
The device name of the root device volume (for example, /dev/sda1
).
SriovNetSupport => Str
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport
at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
VirtualizationType => Str
The type of virtualization (hvm
| paravirtual
).
Default: paravirtual
SEE ALSO
This class forms part of Paws, documenting arguments for method RegisterImage in Paws::EC2
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues