You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RegisterImageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  image_location: "String",
  architecture: "i386", # accepts i386, x86_64, arm64
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1
        kms_key_id: "String",
        encrypted: false,
      },
      no_device: "String",
    },
  ],
  description: "String",
  dry_run: false,
  ena_support: false,
  kernel_id: "KernelId",
  name: "String", # required
  billing_products: ["String"],
  ramdisk_id: "RamdiskId",
  root_device_name: "String",
  sriov_net_support: "String",
  virtualization_type: "String",
}

Contains the parameters for RegisterImage.

See Also:

Instance Attribute Summary collapse

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.

Possible values:

  • i386
  • x86_64
  • arm64

Returns:

  • (String) —

    The architecture of the AMI.

#billing_products ⇒ Array<String>

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

Returns:

  • (Array<String>) —

    The billing product codes.

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

The block device mapping entries.

Returns:

#description ⇒ String

A description for your AMI.

Returns:

  • (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. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (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.

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) —

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

Returns:

  • (String) —

    The full path to your AMI manifest in Amazon S3 storage.

#kernel_id ⇒ String

The ID of the kernel.

Returns:

  • (String) —

    The ID of the kernel.

#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) —

    A name for your AMI.

#ramdisk_id ⇒ String

The ID of the RAM disk.

Returns:

  • (String) —

    The ID of the RAM disk.

#root_device_name ⇒ String

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

Returns:

  • (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.

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) —

    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.

#virtualization_type ⇒ String

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Returns:

  • (String) —

    The type of virtualization (hvm | paravirtual).