Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The ec2Images resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Images resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/ec2Images@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
architecture: {
value: 'string'
}
blockDeviceMappings: [
{
deviceName: 'string'
ebs: {
deleteOnTermination: bool
encrypted: bool
iops: int
kmsKeyId: 'string'
outpostArn: 'string'
snapshotId: 'string'
throughput: int
volumeSize: int
volumeType: {
value: 'string'
}
}
noDevice: 'string'
virtualName: 'string'
}
]
bootMode: {
value: 'string'
}
creationDate: 'string'
deprecationTime: 'string'
deregistrationProtection: 'string'
description: 'string'
enaSupport: bool
hypervisor: {
value: 'string'
}
imageId: 'string'
imageLocation: 'string'
imageOwnerAlias: 'string'
imageType: {
value: 'string'
}
imdsSupport: {
value: 'string'
}
kernelId: 'string'
lastLaunchedTime: 'string'
name: 'string'
ownerId: 'string'
platform: {
value: 'string'
}
platformDetails: 'string'
productCodes: [
{
productCodeId: 'string'
productCodeType: {
value: 'string'
}
}
]
public: bool
ramdiskId: 'string'
rootDeviceName: 'string'
rootDeviceType: {
value: 'string'
}
sourceInstanceId: 'string'
sriovNetSupport: 'string'
state: {
value: 'string'
}
stateReason: {
code: 'string'
message: 'string'
}
tags: [
{
key: 'string'
value: 'string'
}
]
tpmSupport: {
value: 'string'
}
usageOperation: 'string'
virtualizationType: {
value: 'string'
}
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/ec2Images
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2ImageProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ArchitectureValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'arm64' 'arm64_mac' 'i386' 'x86_64' 'x86_64_mac' |
AwsEc2ImageProperties
| Name | Description | Value |
|---|---|---|
| architecture | <p>The architecture of the image.</p> | ArchitectureValuesEnumValue |
| blockDeviceMappings | <p>Any block device mapping entries.</p> | BlockDeviceMapping[] |
| bootMode | <p>The boot mode of the image. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p> | BootModeValuesEnumValue |
| creationDate | <p>The date and time the image was created.</p> | string |
| deprecationTime | <p>The date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.</p> | string |
| deregistrationProtection | <p>Indicates whether deregistration protection is enabled for the AMI.</p> | string |
| description | <p>The description of the AMI that was provided during image creation.</p> | string |
| enaSupport | <p>Specifies whether enhanced networking with ENA is enabled.</p> | bool |
| hypervisor | <p>The hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.</p> | HypervisorTypeEnumValue |
| imageId | <p>The ID of the AMI.</p> | string |
| imageLocation | <p>The location of the AMI.</p> | string |
| imageOwnerAlias | <p>The owner alias (<code>amazon</code> | <code>aws-marketplace</code>).</p> | string |
| imageType | <p>The type of image.</p> | ImageTypeValuesEnumValue |
| imdsSupport | <p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'>Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> | ImdsSupportValuesEnumValue |
| kernelId | <p>The kernel associated with the image, if any. Only applicable for machine images.</p> | string |
| lastLaunchedTime | <p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note> | string |
| name | <p>The name of the AMI that was provided during image creation.</p> | string |
| ownerId | <p>The ID of the Amazon Web Services account that owns the image.</p> | string |
| platform | <p>This value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.</p> | PlatformValuesEnumValue |
| platformDetails | <p>The platform details associated with the billing code of the AMI. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'>Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p> | string |
| productCodes | <p>Any product codes associated with the AMI.</p> | ProductCode[] |
| public | <p>Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.</p> | bool |
| ramdiskId | <p>The RAM disk associated with the image, if any. Only applicable for machine images.</p> | string |
| rootDeviceName | <p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p> | string |
| rootDeviceType | <p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.</p> | DeviceTypeEnumValue |
| sourceInstanceId | <p>The ID of the instance that the AMI was created from if the AMI was created using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>. This field only appears if the AMI was created using CreateImage.</p> | string |
| sriovNetSupport | <p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p> | string |
| state | <p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p> | ImageStateEnumValue |
| stateReason | <p>The reason for the state change.</p> | StateReason |
| tags | <p>Any tags assigned to the image.</p> | TagAutoGenerated11[] |
| tpmSupport | <p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p> | TpmSupportValuesEnumValue |
| usageOperation | <p>The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'>lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'>Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'>DescribeImages</a> command in the Amazon EC2 API, or the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'>describe-images</a> command in the CLI.</p> | string |
| virtualizationType | <p>The type of virtualization of the AMI.</p> | VirtualizationTypeEnumValue |
BlockDeviceMapping
| Name | Description | Value |
|---|---|---|
| deviceName | <p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p> | string |
| ebs | <p>Parameters used to automatically set up EBS volumes when the instance is launched.</p> | EbsBlockDevice |
| noDevice | <p>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.</p> | string |
| virtualName | <p>The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.</p> <p>NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.</p> <p>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.</p> | string |
BootModeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'legacy-bios' 'uefi' 'uefi-preferred' |
DeviceTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ebs' 'instance-store' |
EbsBlockDevice
| Name | Description | Value |
|---|---|---|
| deleteOnTermination | <p>Indicates whether the EBS volume is deleted on instance termination. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'>Preserving Amazon EBS volumes on instance termination</a> in the <i>Amazon EC2 User Guide</i>.</p> | bool |
| encrypted | <p>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 <code>true</code> 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 <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'>Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'>Supported instance types</a>.</p> <p>This parameter is not returned by <a>DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.</p> <ul> <li> <p>If you are creating a block device mapping for a <b>new (empty) volume</b>, you can include this parameter, and specify either <code>true</code> for an encrypted volume, or <code>false</code> for an unencrypted volume. If you omit this parameter, it defaults to <code>false</code> (unencrypted).</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted or unencrypted snapshot</b>, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing unencrypted volume</b>, you can include this parameter, but you must specify <code>false</code>. If you specify <code>true</code>, the request will fail. In this case, we recommend that you omit the parameter.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted volume</b>, you can include this parameter, and specify either <code>true</code> or <code>false</code>. However, if you specify <code>false</code>, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.</p> </li> </ul> | bool |
| iops | <p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type:</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'>instances built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p> <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.</p> | int |
| kmsKeyId | <p>Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.</p> <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>, <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'>RequestSpotFleet</a>, and <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'>RequestSpotInstances</a>.</p> | string |
| outpostArn | <p>The ARN of the Outpost on which the snapshot is stored.</p> <p>This parameter is not supported when using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>.</p> | string |
| snapshotId | <p>The ID of the snapshot.</p> | string |
| throughput | <p>The throughput that the volume supports, in MiB/s.</p> <p>This parameter is valid only for <code>gp3</code> volumes.</p> <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p> | int |
| volumeSize | <p>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.</p> <p>The following are the supported sizes for each volume type:</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p> </li> <li> <p> <code>io1</code>: 4 - 16,384 GiB</p> </li> <li> <p> <code>io2</code>: 4 - 65,536 GiB</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p> </li> <li> <p> <code>standard</code>: 1 - 1024 GiB</p> </li> </ul> | int |
| volumeType | <p>The volume type. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'>Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p> | VolumeTypeEnumValue |
Ec2ImageProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2ImageProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2ImagePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2ImagePropertiesAwsTags
| Name | Description | Value |
|---|
HypervisorTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ovm' 'xen' |
ImageStateEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'available' 'deregistered' 'disabled' 'error' 'failed' 'invalid' 'pending' 'transient' |
ImageTypeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'kernel' 'machine' 'ramdisk' |
ImdsSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
PlatformValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'Windows' |
ProductCode
| Name | Description | Value |
|---|---|---|
| productCodeId | <p>The product code.</p> | string |
| productCodeType | <p>The type of product code.</p> | ProductCodeValuesEnumValue |
ProductCodeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'devpay' 'marketplace' |
StateReason
| Name | Description | Value |
|---|---|---|
| code | <p>The reason code for the state change.</p> | string |
| message | <p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: 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.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: 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.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul> | string |
TagAutoGenerated11
| Name | Description | Value |
|---|---|---|
| key | <p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p> | string |
| value | <p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p> | string |
TpmSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualizationTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'hvm' 'paravirtual' |
VolumeTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'gp2' 'gp3' 'io1' 'io2' 'sc1' 'st1' 'standard' |
ARM template resource definition
The ec2Images resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Images resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/ec2Images",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"architecture": {
"value": "string"
},
"blockDeviceMappings": [
{
"deviceName": "string",
"ebs": {
"deleteOnTermination": "bool",
"encrypted": "bool",
"iops": "int",
"kmsKeyId": "string",
"outpostArn": "string",
"snapshotId": "string",
"throughput": "int",
"volumeSize": "int",
"volumeType": {
"value": "string"
}
},
"noDevice": "string",
"virtualName": "string"
}
],
"bootMode": {
"value": "string"
},
"creationDate": "string",
"deprecationTime": "string",
"deregistrationProtection": "string",
"description": "string",
"enaSupport": "bool",
"hypervisor": {
"value": "string"
},
"imageId": "string",
"imageLocation": "string",
"imageOwnerAlias": "string",
"imageType": {
"value": "string"
},
"imdsSupport": {
"value": "string"
},
"kernelId": "string",
"lastLaunchedTime": "string",
"name": "string",
"ownerId": "string",
"platform": {
"value": "string"
},
"platformDetails": "string",
"productCodes": [
{
"productCodeId": "string",
"productCodeType": {
"value": "string"
}
}
],
"public": "bool",
"ramdiskId": "string",
"rootDeviceName": "string",
"rootDeviceType": {
"value": "string"
},
"sourceInstanceId": "string",
"sriovNetSupport": "string",
"state": {
"value": "string"
},
"stateReason": {
"code": "string",
"message": "string"
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"tpmSupport": {
"value": "string"
},
"usageOperation": "string",
"virtualizationType": {
"value": "string"
}
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/ec2Images
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2ImageProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/ec2Images' |
ArchitectureValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'arm64' 'arm64_mac' 'i386' 'x86_64' 'x86_64_mac' |
AwsEc2ImageProperties
| Name | Description | Value |
|---|---|---|
| architecture | <p>The architecture of the image.</p> | ArchitectureValuesEnumValue |
| blockDeviceMappings | <p>Any block device mapping entries.</p> | BlockDeviceMapping[] |
| bootMode | <p>The boot mode of the image. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p> | BootModeValuesEnumValue |
| creationDate | <p>The date and time the image was created.</p> | string |
| deprecationTime | <p>The date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.</p> | string |
| deregistrationProtection | <p>Indicates whether deregistration protection is enabled for the AMI.</p> | string |
| description | <p>The description of the AMI that was provided during image creation.</p> | string |
| enaSupport | <p>Specifies whether enhanced networking with ENA is enabled.</p> | bool |
| hypervisor | <p>The hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.</p> | HypervisorTypeEnumValue |
| imageId | <p>The ID of the AMI.</p> | string |
| imageLocation | <p>The location of the AMI.</p> | string |
| imageOwnerAlias | <p>The owner alias (<code>amazon</code> | <code>aws-marketplace</code>).</p> | string |
| imageType | <p>The type of image.</p> | ImageTypeValuesEnumValue |
| imdsSupport | <p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'>Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> | ImdsSupportValuesEnumValue |
| kernelId | <p>The kernel associated with the image, if any. Only applicable for machine images.</p> | string |
| lastLaunchedTime | <p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note> | string |
| name | <p>The name of the AMI that was provided during image creation.</p> | string |
| ownerId | <p>The ID of the Amazon Web Services account that owns the image.</p> | string |
| platform | <p>This value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.</p> | PlatformValuesEnumValue |
| platformDetails | <p>The platform details associated with the billing code of the AMI. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'>Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p> | string |
| productCodes | <p>Any product codes associated with the AMI.</p> | ProductCode[] |
| public | <p>Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.</p> | bool |
| ramdiskId | <p>The RAM disk associated with the image, if any. Only applicable for machine images.</p> | string |
| rootDeviceName | <p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p> | string |
| rootDeviceType | <p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.</p> | DeviceTypeEnumValue |
| sourceInstanceId | <p>The ID of the instance that the AMI was created from if the AMI was created using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>. This field only appears if the AMI was created using CreateImage.</p> | string |
| sriovNetSupport | <p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p> | string |
| state | <p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p> | ImageStateEnumValue |
| stateReason | <p>The reason for the state change.</p> | StateReason |
| tags | <p>Any tags assigned to the image.</p> | TagAutoGenerated11[] |
| tpmSupport | <p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p> | TpmSupportValuesEnumValue |
| usageOperation | <p>The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'>lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'>Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'>DescribeImages</a> command in the Amazon EC2 API, or the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'>describe-images</a> command in the CLI.</p> | string |
| virtualizationType | <p>The type of virtualization of the AMI.</p> | VirtualizationTypeEnumValue |
BlockDeviceMapping
| Name | Description | Value |
|---|---|---|
| deviceName | <p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p> | string |
| ebs | <p>Parameters used to automatically set up EBS volumes when the instance is launched.</p> | EbsBlockDevice |
| noDevice | <p>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.</p> | string |
| virtualName | <p>The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.</p> <p>NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.</p> <p>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.</p> | string |
BootModeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'legacy-bios' 'uefi' 'uefi-preferred' |
DeviceTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ebs' 'instance-store' |
EbsBlockDevice
| Name | Description | Value |
|---|---|---|
| deleteOnTermination | <p>Indicates whether the EBS volume is deleted on instance termination. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'>Preserving Amazon EBS volumes on instance termination</a> in the <i>Amazon EC2 User Guide</i>.</p> | bool |
| encrypted | <p>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 <code>true</code> 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 <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'>Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'>Supported instance types</a>.</p> <p>This parameter is not returned by <a>DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.</p> <ul> <li> <p>If you are creating a block device mapping for a <b>new (empty) volume</b>, you can include this parameter, and specify either <code>true</code> for an encrypted volume, or <code>false</code> for an unencrypted volume. If you omit this parameter, it defaults to <code>false</code> (unencrypted).</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted or unencrypted snapshot</b>, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing unencrypted volume</b>, you can include this parameter, but you must specify <code>false</code>. If you specify <code>true</code>, the request will fail. In this case, we recommend that you omit the parameter.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted volume</b>, you can include this parameter, and specify either <code>true</code> or <code>false</code>. However, if you specify <code>false</code>, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.</p> </li> </ul> | bool |
| iops | <p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type:</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'>instances built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p> <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.</p> | int |
| kmsKeyId | <p>Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.</p> <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>, <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'>RequestSpotFleet</a>, and <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'>RequestSpotInstances</a>.</p> | string |
| outpostArn | <p>The ARN of the Outpost on which the snapshot is stored.</p> <p>This parameter is not supported when using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>.</p> | string |
| snapshotId | <p>The ID of the snapshot.</p> | string |
| throughput | <p>The throughput that the volume supports, in MiB/s.</p> <p>This parameter is valid only for <code>gp3</code> volumes.</p> <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p> | int |
| volumeSize | <p>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.</p> <p>The following are the supported sizes for each volume type:</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p> </li> <li> <p> <code>io1</code>: 4 - 16,384 GiB</p> </li> <li> <p> <code>io2</code>: 4 - 65,536 GiB</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p> </li> <li> <p> <code>standard</code>: 1 - 1024 GiB</p> </li> </ul> | int |
| volumeType | <p>The volume type. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'>Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p> | VolumeTypeEnumValue |
Ec2ImageProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2ImageProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2ImagePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2ImagePropertiesAwsTags
| Name | Description | Value |
|---|
HypervisorTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ovm' 'xen' |
ImageStateEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'available' 'deregistered' 'disabled' 'error' 'failed' 'invalid' 'pending' 'transient' |
ImageTypeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'kernel' 'machine' 'ramdisk' |
ImdsSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
PlatformValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'Windows' |
ProductCode
| Name | Description | Value |
|---|---|---|
| productCodeId | <p>The product code.</p> | string |
| productCodeType | <p>The type of product code.</p> | ProductCodeValuesEnumValue |
ProductCodeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'devpay' 'marketplace' |
StateReason
| Name | Description | Value |
|---|---|---|
| code | <p>The reason code for the state change.</p> | string |
| message | <p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: 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.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: 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.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul> | string |
TagAutoGenerated11
| Name | Description | Value |
|---|---|---|
| key | <p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p> | string |
| value | <p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p> | string |
TpmSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualizationTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'hvm' 'paravirtual' |
VolumeTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'gp2' 'gp3' 'io1' 'io2' 'sc1' 'st1' 'standard' |
Usage Examples
Terraform (AzAPI provider) resource definition
The ec2Images resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/ec2Images resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/ec2Images@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
architecture = {
value = "string"
}
blockDeviceMappings = [
{
deviceName = "string"
ebs = {
deleteOnTermination = bool
encrypted = bool
iops = int
kmsKeyId = "string"
outpostArn = "string"
snapshotId = "string"
throughput = int
volumeSize = int
volumeType = {
value = "string"
}
}
noDevice = "string"
virtualName = "string"
}
]
bootMode = {
value = "string"
}
creationDate = "string"
deprecationTime = "string"
deregistrationProtection = "string"
description = "string"
enaSupport = bool
hypervisor = {
value = "string"
}
imageId = "string"
imageLocation = "string"
imageOwnerAlias = "string"
imageType = {
value = "string"
}
imdsSupport = {
value = "string"
}
kernelId = "string"
lastLaunchedTime = "string"
name = "string"
ownerId = "string"
platform = {
value = "string"
}
platformDetails = "string"
productCodes = [
{
productCodeId = "string"
productCodeType = {
value = "string"
}
}
]
public = bool
ramdiskId = "string"
rootDeviceName = "string"
rootDeviceType = {
value = "string"
}
sourceInstanceId = "string"
sriovNetSupport = "string"
state = {
value = "string"
}
stateReason = {
code = "string"
message = "string"
}
tags = [
{
key = "string"
value = "string"
}
]
tpmSupport = {
value = "string"
}
usageOperation = "string"
virtualizationType = {
value = "string"
}
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/ec2Images
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | Ec2ImageProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/ec2Images@2024-12-01" |
ArchitectureValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'arm64' 'arm64_mac' 'i386' 'x86_64' 'x86_64_mac' |
AwsEc2ImageProperties
| Name | Description | Value |
|---|---|---|
| architecture | <p>The architecture of the image.</p> | ArchitectureValuesEnumValue |
| blockDeviceMappings | <p>Any block device mapping entries.</p> | BlockDeviceMapping[] |
| bootMode | <p>The boot mode of the image. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p> | BootModeValuesEnumValue |
| creationDate | <p>The date and time the image was created.</p> | string |
| deprecationTime | <p>The date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.</p> | string |
| deregistrationProtection | <p>Indicates whether deregistration protection is enabled for the AMI.</p> | string |
| description | <p>The description of the AMI that was provided during image creation.</p> | string |
| enaSupport | <p>Specifies whether enhanced networking with ENA is enabled.</p> | bool |
| hypervisor | <p>The hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.</p> | HypervisorTypeEnumValue |
| imageId | <p>The ID of the AMI.</p> | string |
| imageLocation | <p>The location of the AMI.</p> | string |
| imageOwnerAlias | <p>The owner alias (<code>amazon</code> | <code>aws-marketplace</code>).</p> | string |
| imageType | <p>The type of image.</p> | ImageTypeValuesEnumValue |
| imdsSupport | <p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'>Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p> | ImdsSupportValuesEnumValue |
| kernelId | <p>The kernel associated with the image, if any. Only applicable for machine images.</p> | string |
| lastLaunchedTime | <p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note> | string |
| name | <p>The name of the AMI that was provided during image creation.</p> | string |
| ownerId | <p>The ID of the Amazon Web Services account that owns the image.</p> | string |
| platform | <p>This value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.</p> | PlatformValuesEnumValue |
| platformDetails | <p>The platform details associated with the billing code of the AMI. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'>Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p> | string |
| productCodes | <p>Any product codes associated with the AMI.</p> | ProductCode[] |
| public | <p>Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.</p> | bool |
| ramdiskId | <p>The RAM disk associated with the image, if any. Only applicable for machine images.</p> | string |
| rootDeviceName | <p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p> | string |
| rootDeviceType | <p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.</p> | DeviceTypeEnumValue |
| sourceInstanceId | <p>The ID of the instance that the AMI was created from if the AMI was created using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>. This field only appears if the AMI was created using CreateImage.</p> | string |
| sriovNetSupport | <p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p> | string |
| state | <p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p> | ImageStateEnumValue |
| stateReason | <p>The reason for the state change.</p> | StateReason |
| tags | <p>Any tags assigned to the image.</p> | TagAutoGenerated11[] |
| tpmSupport | <p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p> | TpmSupportValuesEnumValue |
| usageOperation | <p>The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'>lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'>Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'>DescribeImages</a> command in the Amazon EC2 API, or the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'>describe-images</a> command in the CLI.</p> | string |
| virtualizationType | <p>The type of virtualization of the AMI.</p> | VirtualizationTypeEnumValue |
BlockDeviceMapping
| Name | Description | Value |
|---|---|---|
| deviceName | <p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p> | string |
| ebs | <p>Parameters used to automatically set up EBS volumes when the instance is launched.</p> | EbsBlockDevice |
| noDevice | <p>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.</p> | string |
| virtualName | <p>The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.</p> <p>NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.</p> <p>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.</p> | string |
BootModeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'legacy-bios' 'uefi' 'uefi-preferred' |
DeviceTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ebs' 'instance-store' |
EbsBlockDevice
| Name | Description | Value |
|---|---|---|
| deleteOnTermination | <p>Indicates whether the EBS volume is deleted on instance termination. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'>Preserving Amazon EBS volumes on instance termination</a> in the <i>Amazon EC2 User Guide</i>.</p> | bool |
| encrypted | <p>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 <code>true</code> 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 <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'>Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'>Supported instance types</a>.</p> <p>This parameter is not returned by <a>DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.</p> <ul> <li> <p>If you are creating a block device mapping for a <b>new (empty) volume</b>, you can include this parameter, and specify either <code>true</code> for an encrypted volume, or <code>false</code> for an unencrypted volume. If you omit this parameter, it defaults to <code>false</code> (unencrypted).</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted or unencrypted snapshot</b>, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing unencrypted volume</b>, you can include this parameter, but you must specify <code>false</code>. If you specify <code>true</code>, the request will fail. In this case, we recommend that you omit the parameter.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted volume</b>, you can include this parameter, and specify either <code>true</code> or <code>false</code>. However, if you specify <code>false</code>, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.</p> </li> </ul> | bool |
| iops | <p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type:</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'>instances built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p> <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.</p> | int |
| kmsKeyId | <p>Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.</p> <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>, <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'>RequestSpotFleet</a>, and <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'>RequestSpotInstances</a>.</p> | string |
| outpostArn | <p>The ARN of the Outpost on which the snapshot is stored.</p> <p>This parameter is not supported when using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>.</p> | string |
| snapshotId | <p>The ID of the snapshot.</p> | string |
| throughput | <p>The throughput that the volume supports, in MiB/s.</p> <p>This parameter is valid only for <code>gp3</code> volumes.</p> <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p> | int |
| volumeSize | <p>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.</p> <p>The following are the supported sizes for each volume type:</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p> </li> <li> <p> <code>io1</code>: 4 - 16,384 GiB</p> </li> <li> <p> <code>io2</code>: 4 - 65,536 GiB</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p> </li> <li> <p> <code>standard</code>: 1 - 1024 GiB</p> </li> </ul> | int |
| volumeType | <p>The volume type. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'>Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p> | VolumeTypeEnumValue |
Ec2ImageProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsEc2ImageProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | Ec2ImagePropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
Ec2ImagePropertiesAwsTags
| Name | Description | Value |
|---|
HypervisorTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'ovm' 'xen' |
ImageStateEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'available' 'deregistered' 'disabled' 'error' 'failed' 'invalid' 'pending' 'transient' |
ImageTypeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'kernel' 'machine' 'ramdisk' |
ImdsSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
PlatformValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'Windows' |
ProductCode
| Name | Description | Value |
|---|---|---|
| productCodeId | <p>The product code.</p> | string |
| productCodeType | <p>The type of product code.</p> | ProductCodeValuesEnumValue |
ProductCodeValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'devpay' 'marketplace' |
StateReason
| Name | Description | Value |
|---|---|---|
| code | <p>The reason code for the state change.</p> | string |
| message | <p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: 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.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: 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.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul> | string |
TagAutoGenerated11
| Name | Description | Value |
|---|---|---|
| key | <p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p> | string |
| value | <p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p> | string |
TpmSupportValuesEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'v2.0' |
TrackedResourceTags
| Name | Description | Value |
|---|
VirtualizationTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'hvm' 'paravirtual' |
VolumeTypeEnumValue
| Name | Description | Value |
|---|---|---|
| value | Property value | 'gp2' 'gp3' 'io1' 'io2' 'sc1' 'st1' 'standard' |