aws_ami

account_id

Type: STRING

architecture

Type: STRING
Provider name: Architecture
Description: The architecture of the image.

arn

Type: STRING

block_device_mappings

Type: UNORDERED_LIST_STRUCT
Provider name: BlockDeviceMappings
Description: Any block device mapping entries.

  • device_name
    Type: STRING
    Provider name: DeviceName
    Description: The device name (for example, /dev/sdh or xvdh).
  • ebs
    Type: STRUCT
    Provider name: Ebs
    Description: Parameters used to automatically set up EBS volumes when the instance is launched.
    • delete_on_termination
      Type: BOOLEAN
      Provider name: DeleteOnTermination
      Description: Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
    • encrypted
      Type: BOOLEAN
      Provider name: Encrypted
      Description: Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
      • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
      • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
      • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
      • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
    • iops
      Type: INT32
      Provider name: Iops
      Description: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type:
      • gp3: 3,000 - 16,000 IOPS
      • io1: 100 - 64,000 IOPS
      • io2: 100 - 256,000 IOPS
      For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
    • kms_key_id
      Type: STRING
      Provider name: KmsKeyId
      Description: Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted. This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
    • outpost_arn
      Type: STRING
      Provider name: OutpostArn
      Description: The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage.
    • snapshot_id
      Type: STRING
      Provider name: SnapshotId
      Description: The ID of the snapshot.
    • throughput
      Type: INT32
      Provider name: Throughput
      Description: The throughput that the volume supports, in MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000.
    • volume_size
      Type: INT32
      Provider name: VolumeSize
      Description: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported sizes for each volume type:
      • gp2 and gp3: 1 - 16,384 GiB
      • io1: 4 - 16,384 GiB
      • io2: 4 - 65,536 GiB
      • st1 and sc1: 125 - 16,384 GiB
      • standard: 1 - 1024 GiB
    • volume_type
      Type: STRING
      Provider name: VolumeType
      Description: The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.
  • no_device
    Type: STRING
    Provider name: NoDevice
    Description: To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
  • virtual_name
    Type: STRING
    Provider name: VirtualName
    Description: The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

boot_mode

Type: STRING
Provider name: BootMode
Description: The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

creation_date

Type: STRING
Provider name: CreationDate
Description: The date and time the image was created.

deprecation_time

Type: STRING
Provider name: DeprecationTime
Description: The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

description

Type: STRING
Provider name: Description
Description: The description of the AMI that was provided during image creation.

ena_support

Type: BOOLEAN
Provider name: EnaSupport
Description: Specifies whether enhanced networking with ENA is enabled.

hypervisor

Type: STRING
Provider name: Hypervisor
Description: The hypervisor type of the image. Only xen is supported. ovm is not supported.

image_id

Type: STRING
Provider name: ImageId
Description: The ID of the AMI.

image_location

Type: STRING
Provider name: ImageLocation
Description: The location of the AMI.

image_owner_alias

Type: STRING
Provider name: ImageOwnerAlias
Description: The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.

image_type

Type: STRING
Provider name: ImageType
Description: The type of image.

imds_support

Type: STRING
Provider name: ImdsSupport
Description: If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

kernel_id

Type: STRING
Provider name: KernelId
Description: The kernel associated with the image, if any. Only applicable for machine images.

name

Type: STRING
Provider name: Name
Description: The name of the AMI that was provided during image creation.

owner_id

Type: STRING
Provider name: OwnerId
Description: The ID of the Amazon Web Services account that owns the image.

platform

Type: STRING
Provider name: Platform
Description: This value is set to windows for Windows AMIs; otherwise, it is blank.

platform_details

Type: STRING
Provider name: PlatformDetails
Description: The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

product_codes

Type: UNORDERED_LIST_STRUCT
Provider name: ProductCodes
Description: Any product codes associated with the AMI.

  • product_code_id
    Type: STRING
    Provider name: ProductCodeId
    Description: The product code.
  • product_code_type
    Type: STRING
    Provider name: ProductCodeType
    Description: The type of product code.

public

Type: BOOLEAN
Provider name: Public
Description: Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

ramdisk_id

Type: STRING
Provider name: RamdiskId
Description: The RAM disk associated with the image, if any. Only applicable for machine images.

root_device_name

Type: STRING
Provider name: RootDeviceName
Description: The device name of the root device volume (for example, /dev/sda1).

root_device_type

Type: STRING
Provider name: RootDeviceType
Description: The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

source_instance_id

Type: STRING
Provider name: SourceInstanceId
Description: The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

sriov_net_support

Type: STRING
Provider name: SriovNetSupport
Description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

state

Type: STRING
Provider name: State
Description: The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

state_reason

Type: STRUCT
Provider name: StateReason
Description: The reason for the state change.

  • code
    Type: STRING
    Provider name: Code
    Description: The reason code for the state change.
  • message
    Type: STRING
    Provider name: Message
    Description: The message for the state change.
    • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
    • Server.InternalError: An internal error caused the instance to terminate during launch.
    • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
    • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
    • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
    • Client.InstanceInitiatedShutdown: The instance was shut down from the operating system of the instance.
    • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
    • Client.InternalError: A client error caused the instance to terminate during launch.
    • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
    • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
    • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
    • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

tags

Type: UNORDERED_LIST_STRING

tpm_support

Type: STRING
Provider name: TpmSupport
Description: If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

usage_operation

Type: STRING
Provider name: UsageOperation
Description: The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

virtualization_type

Type: STRING
Provider name: VirtualizationType
Description: The type of virtualization of the AMI.