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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

The block device mappings.

When using the CreateImage action:

  • You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.

  • You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), copy the image instead.

  • The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.

Returns:



12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#boot_mode_override ⇒ String

The boot mode of the new image, which overrides the default boot mode. By default, if you do not specify this parameter, the new image inherits the boot-mode from the source instance.

A value of uefi indicates that the image only supports UEFI boot mode. You can specify this parameter only if the current-instance-boot-mode of the source instance is uefi. To find the boot-mode or current-instance-boot-mode of an instance, see DescribeInstances.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

Returns:

  • (String) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the new image.

Returns:

  • (String) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  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) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance.

Returns:

  • (String) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  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) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#no_reboot ⇒ Boolean

Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:

  • true - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.

  • false - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.

Default: false

Returns:

  • (Boolean) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_location ⇒ String

Only supported for instances in Local Zones and for instances on Outposts that support local snapshots. If the source instance is not in one of these locations, omit this parameter.

The Amazon S3 location where the snapshots will be stored.

  • To create local snapshots in the same Local Zone or on the same Outpost as the source instance, specify local.

  • To create regional snapshots in the parent Region of the Local Zone or Outpost, specify regional.

If the source instance is in a Local Zone and you omit this parameter, regional snapshots are created in the parent Region of the Local Zone.

If the source instance is on an Outpost that supports local snapshots, this parameter is required. If you omit it, the request fails with an InvalidParameterValue error.

Default: regional (for instances in Local Zones only)

Returns:

  • (String) 


12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

  • To tag the AMI, the value for ResourceType must be image.

  • To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Returns:



12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12032

class CreateImageRequest < Struct.new(
  :tag_specifications,
  :snapshot_location,
  :boot_mode_override,
  :dry_run,
  :instance_id,
  :name,
  :description,
  :no_reboot,
  :block_device_mappings)
  SENSITIVE = []
  include Aws::Structure
end