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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass RegisterImageRequest data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#architectureString

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

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


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#block_device_mappingsArray<Types::BlockDeviceMapping>

The block device mapping entries.

Returns:



40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for your AMI.

Returns:

  • (String)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#ena_supportBoolean

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#image_locationString

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#kernel_idString

The ID of the kernel.

Returns:

  • (String)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#ramdisk_idString

The ID of the RAM disk.

Returns:

  • (String)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#root_device_nameString

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

Returns:

  • (String)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#sriov_net_supportString

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)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end

#virtualization_typeString

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Returns:

  • (String)


40437
40438
40439
40440
40441
40442
40443
40444
40445
40446
40447
40448
40449
40450
40451
40452
40453
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40437

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)
  SENSITIVE = []
  include Aws::Structure
end