NAME

Paws::EC2::ImportImage - Arguments for method ImportImage on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method ImportImage on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method ImportImage.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportImage.

SYNOPSIS

    my $ec2 = Paws->service('EC2');
    my $ImportImageResult = $ec2->ImportImage(
      Architecture => 'MyString',    # OPTIONAL
      ClientData   => {
        Comment     => 'MyString',
        UploadEnd   => '1970-01-01T01:00:00',    # OPTIONAL
        UploadSize  => 1,                        # OPTIONAL
        UploadStart => '1970-01-01T01:00:00',    # OPTIONAL
      },    # OPTIONAL
      ClientToken    => 'MyString',    # OPTIONAL
      Description    => 'MyString',    # OPTIONAL
      DiskContainers => [
        {
          Description => 'MyString',
          DeviceName  => 'MyString',
          Format      => 'MyString',
          SnapshotId  => 'MySnapshotId',    # OPTIONAL
          Url         => 'MyString',
          UserBucket  => {
            S3Bucket => 'MyString',
            S3Key    => 'MyString',
          },                                # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      DryRun                => 1,                               # OPTIONAL
      Encrypted             => 1,                               # OPTIONAL
      Hypervisor            => 'MyString',                      # OPTIONAL
      KmsKeyId              => 'MyKmsKeyId',                    # OPTIONAL
      LicenseSpecifications =>
        [ { LicenseConfigurationArn => 'MyString', }, ... ],    # OPTIONAL
      LicenseType       => 'MyString',                          # OPTIONAL
      Platform          => 'MyString',                          # OPTIONAL
      RoleName          => 'MyString',                          # OPTIONAL
      TagSpecifications => [
        {
          ResourceType => 'client-vpn-endpoint'
          , # 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
          Tags => [
            {
              Key   => 'MyString',
              Value => 'MyString',
            },
            ...
          ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $Architecture          = $ImportImageResult->Architecture;
    my $Description           = $ImportImageResult->Description;
    my $Encrypted             = $ImportImageResult->Encrypted;
    my $Hypervisor            = $ImportImageResult->Hypervisor;
    my $ImageId               = $ImportImageResult->ImageId;
    my $ImportTaskId          = $ImportImageResult->ImportTaskId;
    my $KmsKeyId              = $ImportImageResult->KmsKeyId;
    my $LicenseSpecifications = $ImportImageResult->LicenseSpecifications;
    my $LicenseType           = $ImportImageResult->LicenseType;
    my $Platform              = $ImportImageResult->Platform;
    my $Progress              = $ImportImageResult->Progress;
    my $SnapshotDetails       = $ImportImageResult->SnapshotDetails;
    my $Status                = $ImportImageResult->Status;
    my $StatusMessage         = $ImportImageResult->StatusMessage;
    my $Tags                  = $ImportImageResult->Tags;
    # Returns a L<Paws::EC2::ImportImageResult> 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/ImportImage>

ATTRIBUTES

Architecture => Str

The architecture of the virtual machine.

Valid values: "i386" | "x86_64" | "arm64"

ClientData => Paws::EC2::ClientData

The client-specific data.

ClientToken => Str

The token to enable idempotency for VM import requests.

Description => Str

A description string for the import image task.

DiskContainers => ArrayRef[Paws::EC2::ImageDiskContainer]

Information about the disk containers.

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".

Encrypted => Bool

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using "KmsKeyId". For more information, see Amazon EBS Encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the Amazon Elastic Compute Cloud User Guide.

Hypervisor => Str

The target hypervisor platform.

Valid values: "xen"

KmsKeyId => Str

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a "KmsKeyId" is specified, the "Encrypted" flag must also be set.

The CMK identifier may be provided in any of the following formats:

Key ID
Key alias. The alias ARN contains the "arn:aws:kms" namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the "alias" namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the "arn:aws:kms" namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the "key" namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the "arn:aws:kms" namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the "alias" namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses "KmsKeyId" asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

LicenseSpecifications => ArrayRef[Paws::EC2::ImportImageLicenseConfigurationRequest]

The ARNs of the license configurations.

LicenseType => Str

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify "AWS" to replace the source-system license with an AWS license, if appropriate. Specify "BYOL" to retain the source-system license, if appropriate.

To use "BYOL", you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites (https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image) in the VM Import/Export User Guide.

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>