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: "KmsKeyId",
  snapshot_id: "SnapshotId",
  volume_size: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  throughput: 1,
}

The parameters for a block device for an EBS volume.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_terminationBoolean

Indicates whether the EBS volume is deleted on instance termination.

Returns:

  • (Boolean)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

class LaunchTemplateEbsBlockDeviceRequest < Struct.new(
  :encrypted,
  :delete_on_termination,
  :iops,
  :kms_key_id,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :throughput)
  SENSITIVE = []
  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)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#iopsInteger

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#kms_key_idString

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

Returns:

  • (String)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#snapshot_idString

The ID of the snapshot.

Returns:

  • (String)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#throughputInteger

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

Valid Range: Minimum value of 125. Maximum value of 1000.

Returns:

  • (Integer)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#volume_sizeInteger

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Returns:

  • (Integer)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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

#volume_typeString

The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


37756
37757
37758
37759
37760
37761
37762
37763
37764
37765
37766
37767
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 37756

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