Class: Aws::EC2::Types::RegisterImageRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::RegisterImageRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Contains the parameters for RegisterImage.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#architecture ⇒ String

The architecture of the AMI.
#billing_products ⇒ Array<String>

The billing product codes.
#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

The block device mapping entries.
#boot_mode ⇒ String

The boot mode of the AMI.
#description ⇒ String

A description for your AMI.
#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#ena_support ⇒ Boolean

Set to ‘true` to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
#image_location ⇒ String

The full path to your AMI manifest in Amazon S3 storage.
#imds_support ⇒ String

Set to ‘v2.0` to indicate that IMDSv2 is specified in the AMI.
#kernel_id ⇒ String

The ID of the kernel.
#name ⇒ String

A name for your AMI.
#ramdisk_id ⇒ String

The ID of the RAM disk.
#root_device_name ⇒ String

The device name of the root device volume (for example, ‘/dev/sda1`).
#sriov_net_support ⇒ 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.
#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the AMI.
#tpm_support ⇒ String

Set to ‘v2.0` to enable Trusted Platform Module (TPM) support.
#uefi_data ⇒ String

Base64 representation of the non-volatile UEFI variable store.
#virtualization_type ⇒ String

The type of virtualization (‘hvm` | `paravirtual`).

Instance Attribute Details

#architecture ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#billing_products ⇒ `Array<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*.

[1]: docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html [2]: docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#block_device_mappings ⇒ `Array<Types::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 EBS User Guide*.

[1]: docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami

Returns:

(Array<Types::BlockDeviceMapping>)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#boot_mode ⇒ `String`

The boot mode of the AMI. A value of ‘uefi-preferred` indicates that the AMI supports both UEFI and Legacy BIOS.

<note markdown=“1”> The operating system contained in the AMI must be configured to support the specified boot mode.

</note>

For more information, see [Boot modes] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description for your AMI.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#ena_support ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#image_location ⇒ `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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#imds_support ⇒ `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*.

<note markdown=“1”> If you set the value to ‘v2.0`, make sure that your AMI software can support IMDSv2.

</note>

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#kernel_id ⇒ `String`

The ID of the kernel.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

A name for your AMI.

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#ramdisk_id ⇒ `String`

The ID of the RAM disk.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#root_device_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#sriov_net_support ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The tags to apply to the AMI.

To tag the AMI, the value for ‘ResourceType` must be `image`. If you specify another value for `ResourceType`, the request fails.

To tag an AMI after it has been registered, see [CreateTags].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

Returns:

(Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tpm_support ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#uefi_data ⇒ `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][2: on GitHub. For more information, see [UEFI

Secure Boot] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData [2]: github.com/awslabs/python-uefivars [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#virtualization_type ⇒ `String`

The type of virtualization (‘hvm` | `paravirtual`).

Default: ‘paravirtual`

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 55188

class RegisterImageRequest < Struct.new(
  :image_location,
  :architecture,
  :block_device_mappings,
  :description,
  :dry_run,
  :ena_support,
  :kernel_id,
  :name,
  :billing_products,
  :ramdisk_id,
  :root_device_name,
  :sriov_net_support,
  :virtualization_type,
  :boot_mode,
  :tpm_support,
  :uefi_data,
  :imds_support,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::RegisterImageRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#architecture ⇒ String

#billing_products ⇒ Array<String>

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

#boot_mode ⇒ String

#description ⇒ String

#dry_run ⇒ Boolean

#ena_support ⇒ Boolean

#image_location ⇒ String

#imds_support ⇒ String

#kernel_id ⇒ String

#name ⇒ String

#ramdisk_id ⇒ String

#root_device_name ⇒ String

#sriov_net_support ⇒ String

#tag_specifications ⇒ Array<Types::TagSpecification>

#tpm_support ⇒ String

#uefi_data ⇒ String

#virtualization_type ⇒ String

#architecture ⇒ `String`

#billing_products ⇒ `Array<String>`

#block_device_mappings ⇒ `Array<Types::BlockDeviceMapping>`

#boot_mode ⇒ `String`

#description ⇒ `String`

#dry_run ⇒ `Boolean`

#ena_support ⇒ `Boolean`

#image_location ⇒ `String`

#imds_support ⇒ `String`

#kernel_id ⇒ `String`

#name ⇒ `String`

#ramdisk_id ⇒ `String`

#root_device_name ⇒ `String`

#sriov_net_support ⇒ `String`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#tpm_support ⇒ `String`

#uefi_data ⇒ `String`

#virtualization_type ⇒ `String`