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

Class: Aws::EC2::Types::LaunchTemplateEbsBlockDeviceRequest

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 LaunchTemplateEbsBlockDeviceRequest data as a hash:

{
  encrypted: false,
  delete_on_termination: false,
  iops: 1,
  kms_key_id: "String",
  snapshot_id: "String",
  volume_size: 1,
  volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
}

The parameters for a block device for an EBS volume.

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_terminationBoolean

Indicates whether the EBS volume is deleted on instance termination.

Returns:

  • (Boolean)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#encryptedBoolean

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Returns:

  • (Boolean)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#iopsInteger

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#kms_key_idString

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

Returns:

  • (String)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#snapshot_idString

The ID of the snapshot.

Returns:

  • (String)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#volume_sizeInteger

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Returns:

  • (Integer)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end

#volume_typeString

The volume type.

Returns:

  • (String)


19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19527

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type)
  include Aws::Structure
end