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

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
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        encrypted: false,
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
      },
      no_device: "String",
    },
  ],
  description: "String",
  dry_run: false,
  ena_support: false,
  kernel_id: "String",
  name: "String", # required
  billing_products: ["String"],
  ramdisk_id: "String",
  root_device_name: "String",
  sriov_net_support: "String",
  virtualization_type: "String",
}

Contains the parameters for RegisterImage.

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)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#block_device_mappingsArray<Types::BlockDeviceMapping>

One or more block device mapping entries.

Returns:



19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#descriptionString

A description for your AMI.

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#image_locationString

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

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#kernel_idString

The ID of the kernel.

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#ramdisk_idString

The ID of the RAM disk.

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#root_device_nameString

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

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end

#virtualization_typeString

The type of virtualization.

Default: paravirtual

Returns:

  • (String)


19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19261

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)
  include Aws::Structure
end