amazon.aws.ec2_import_image module – Manage AWS EC2 import image tasks

Note

This module is part of the amazon.aws collection (version 7.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_import_image.

New in amazon.aws 7.0.0

Synopsis

  • Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

  • Cancel an in-process import virtual machine task.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.26.0

  • botocore >= 1.29.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

architecture

string

The architecture of the virtual machine.

Choices:

  • "i386"

  • "x86_64"

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

boot_mode

string

The boot mode of the virtual machine.

Choices:

  • "legacy-bios"

  • "uefi"

cancel_reason

string

The reason for canceling the task.

client_data

dictionary

The client-specific data.

comment

string

A user-defined comment about the disk upload.

upload_end

string

The time that the disk upload ends.

upload_size

float

The size of the uploaded disk image, in GiB.

upload_start

string

The time that the disk upload starts.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

description

string

A description string for the import image task.

disk_containers

list / elements=dictionary

Information about the disk containers.

description

string

The description of the disk image.

device_name

string

The block device mapping for the disk.

format

string

The format of the disk image being imported.

Choices:

  • "OVA"

  • "ova"

  • "VHD"

  • "vhd"

  • "VHDX"

  • "vhdx"

  • "VMDK"

  • "vmdk"

  • "RAW"

  • "raw"

snapshot_id

string

The ID of the EBS snapshot to be used for importing the snapshot.

url

string

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

user_bucket

dictionary

The S3 bucket for the disk image.

s3_bucket

string

The name of the Amazon S3 bucket where the disk image is located.

s3_key

string

The file name of the disk image.

encrypted

boolean

Specifies whether the destination AMI of the imported image should be encrypted.

The default KMS key for EBS is used unless you specify a non-default KMS key using kms_key_id.

Choices:

  • false

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

hypervisor

string

The target hypervisor platform.

Choices:

  • "xen"

kms_key_id

string

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a kms_key_id is specified, the encrypted flag must also be set.

license_specifications

list / elements=dictionary

The ARNs of the license configurations.

license_configuration_arn

string

The ARN of a license configuration.

license_type

string

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

platform

string

The operating system of the virtual machine.

Choices:

  • "Windows"

  • "Linux"

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

role_name

string

The name of the role to use when not using the default role, ‘vmimport’.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

state

string

Use state=present to import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

Use state=absent to cancel an in-process import virtual machine task.

Choices:

  • "present" ← (default)

  • "absent"

tags

aliases: resource_tags

dictionary

The tags to apply to the import image task during creation.

task_name

aliases: name

string / required

The name of the EC2 image import task.

usage_operation

string

The usage operation value.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Import image
  amazon.aws.ec2_import_image:
    state: present
    task_name: "clone-vm-import-image"
    disk_containers:
      - format: raw
        user_bucket:
          s3_bucket: "clone-vm-s3-bucket"
          s3_key: "clone-vm-s3-bucket/ubuntu-vm-clone.raw"

- name: Cancel an import image task
  amazon.aws.ec2_import_image:
    state: absent
    task_name: "clone-vm-import-image"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

import_image

complex

A dict containing information about an EC2 import task.

Returned: always

architecture

string

The architecture of the virtual machine.

Returned: success

description

string

A description string for the import image task.

Returned: success

encrypted

boolean

Specifies whether the destination AMI of the imported image should be encrypted.

Returned: success

hypervisor

string

The target hypervisor platform.

Returned: success

image_id

string

The ID of the Amazon Machine Image (AMI) created by the import task.

Returned: success

import_task_id

string

The task ID of the import image task.

Returned: success

kms_key_id

string

The identifier for the symmetric KMS key that was used to create the encrypted AMI.

Returned: success

license_specifications

dictionary

The ARNs of the license configurations.

Returned: success

license_type

string

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

Returned: success

platform

string

The operating system of the virtual machine.

Returned: success

progress

string

The progress of the task.

Returned: success

role_name

string

The name of the role to use when not using the default role, ‘vmimport’.

Returned: success

snapshot_details

dictionary

Describes the snapshot created from the imported disk.

Returned: success

description

string

A description for the snapshot.

Returned: success

device_name

string

The block device mapping for the snapshot.

Returned: success

disk_image_size

float

The size of the disk in the snapshot, in GiB.

Returned: success

format

string

The format of the disk image from which the snapshot is created.

Returned: success

progress

string

The percentage of progress for the task.

Returned: success

snapshot_id

string

The snapshot ID of the disk being imported.

Returned: success

status

string

A brief status of the snapshot creation.

Returned: success

status_message

string

A detailed status message for the snapshot creation.

Returned: success

url

string

The URL used to access the disk image.

Returned: success

user_bucket

dictionary

The Amazon S3 bucket for the disk image.

Returned: success

status

string

A brief status of the task.

Returned: success

status_message

string

A detailed status message of the import task.

Returned: success

tags

dictionary

The tags to apply to the import image task during creation.

Returned: success

task_name

string

The name of the EC2 image import task.

Returned: success

usage_operation

dictionary

The usage operation value.

Returned: success

Authors

  • Alina Buzachis (@alinabuzachis)