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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::LaunchTemplateEbsBlockDeviceRequest

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #delete_on_termination ⇒ Boolean

  Indicates whether the EBS volume is deleted on instance termination.

• #encrypted ⇒ Boolean

  Indicates whether the EBS volume is encrypted.

• #iops ⇒ Integer

  The number of I/O operations per second (IOPS).

• #kms_key_id ⇒ String

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

• #snapshot_id ⇒ String

  The ID of the snapshot.

• #throughput ⇒ Integer

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

• #volume_size ⇒ Integer

  The size of the volume, in GiBs.

• #volume_type ⇒ String

  The volume type.

Instance Attribute Details

#delete_on_termination ⇒ Boolean

Indicates whether the EBS volume is deleted on instance termination.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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

#encrypted ⇒ Boolean

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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

#iops ⇒ Integer

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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_id ⇒ String

The ID of the snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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

#throughput ⇒ Integer

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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_size ⇒ Integer

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45189

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