Class: Aws::EC2::Types::CreateImageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::CreateImageRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
When making an API call, you may pass CreateImageRequest data as a hash:
{
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, gp2, sc1, st1
encrypted: false,
kms_key_id: "String",
},
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
-
#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. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 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.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 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`.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 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.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 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(_)
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 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.
5084 5085 5086 5087 5088 5089 5090 5091 5092 |
# File 'lib/aws-sdk-ec2/types.rb', line 5084 class CreateImageRequest < Struct.new( :block_device_mappings, :description, :dry_run, :instance_id, :name, :no_reboot) include Aws::Structure end |