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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappingsArray<Types::BlockDeviceMapping>

Information about one or more block device mappings.

Returns:



2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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

#descriptionString

A description for the new image.

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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


2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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

#instance_idString

The ID of the instance.

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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

#nameString

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)


2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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

#no_rebootBoolean

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)


2745
2746
2747
2748
2749
2750
2751
2752
2753
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2745

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