Class: Aws::EC2::Types::CreateImageRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateImageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateImageRequest data as a hash:

{
  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,
  instance_id: "String", # required
  name: "String", # required
  no_reboot: false,
}

Contains the parameters for CreateImage.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

  Information about one or more block device mappings.

• #description ⇒ String

  A description for the new image.

• #dry_run ⇒ Boolean

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

• #instance_id ⇒ String

  The ID of the instance.

• #name ⇒ String

  A name for the new image.

• #no_reboot ⇒ Boolean

  By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.

Instance Attribute Details

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

Information about one or more block device mappings.

Returns:

• (Array<Types::BlockDeviceMapping>)

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

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  include Aws::Structure
end

#description ⇒ String

A description for the new image.

Returns:

• (String)

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

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  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 2769

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

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

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  include Aws::Structure
end

#name ⇒ String

A name for the new image.

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 2769

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  include Aws::Structure
end

#no_reboot ⇒ Boolean

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the ‘No Reboot’ option is set, Amazon EC2 doesn’t shut down the instance before creating the image. When this option is used, file system integrity on the created image can’t be guaranteed.

Returns:

• (Boolean)

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

class CreateImageRequest < Struct.new(
  :block_device_mappings,
  :description,
  :dry_run,
  :instance_id,
  :name,
  :no_reboot)
  include Aws::Structure
end