Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RegisterImageRequest

Contains the parameters for RegisterImage.

Hierarchy

Index

Properties

Optional Architecture

Architecture: ArchitectureValues | string

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Optional BillingProducts

BillingProducts: string[]

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Optional BlockDeviceMappings

BlockDeviceMappings: BlockDeviceMapping[]

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

Optional BootMode

BootMode: BootModeValues | string

The boot mode of the AMI. For more information, see Boot modes in the Amazon EC2 User Guide.

Optional Description

Description: undefined | string

A description for your AMI.

Optional DryRun

DryRun: undefined | false | true

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.

Optional EnaSupport

EnaSupport: undefined | false | true

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Optional ImageLocation

ImageLocation: undefined | string

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Optional ImdsSupport

ImdsSupport: ImdsSupportValues | string

Set to v2.0 to indicate 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.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Optional KernelId

KernelId: undefined | string

The ID of the kernel.

Name

Name: string | undefined

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Optional RamdiskId

RamdiskId: undefined | string

The ID of the RAM disk.

Optional RootDeviceName

RootDeviceName: undefined | string

The device name of the root device volume (for example, /dev/sda1).

Optional SriovNetSupport

SriovNetSupport: undefined | string

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Optional TpmSupport

TpmSupport: TpmSupportValues | string

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Optional UefiData

UefiData: undefined | string

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Optional VirtualizationType

VirtualizationType: undefined | string

The type of virtualization (hvm | paravirtual).

Default: paravirtual