Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Documentation

data LaunchTemplateEbsBlockDeviceRequest

The parameters for a block device for an EBS volume.

See: newLaunchTemplateEbsBlockDeviceRequest smart constructor.

Constructors

LaunchTemplateEbsBlockDeviceRequest'

Fields

• deleteOnTermination :: Maybe Bool

  Indicates whether the EBS volume is deleted on instance termination.

• encrypted :: Maybe Bool

  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.

• iops :: Maybe Int

  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.

• kmsKeyId :: Maybe Text

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

• snapshotId :: Maybe Text

  The ID of the snapshot.

• throughput :: Maybe Int

  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.

• volumeSize :: Maybe Int

  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
• volumeType :: Maybe VolumeType

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

Instances

ToQuery LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

toQuery :: LaunchTemplateEbsBlockDeviceRequest -> QueryString

Generic LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Associated Types

type Rep LaunchTemplateEbsBlockDeviceRequest :: Type -> Type

Methods

from :: LaunchTemplateEbsBlockDeviceRequest -> Rep LaunchTemplateEbsBlockDeviceRequest x

to :: Rep LaunchTemplateEbsBlockDeviceRequest x -> LaunchTemplateEbsBlockDeviceRequest

Read LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

readsPrec :: Int -> ReadS LaunchTemplateEbsBlockDeviceRequest

readList :: ReadS [LaunchTemplateEbsBlockDeviceRequest]

readPrec :: ReadPrec LaunchTemplateEbsBlockDeviceRequest

readListPrec :: ReadPrec [LaunchTemplateEbsBlockDeviceRequest]

Show LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

showsPrec :: Int -> LaunchTemplateEbsBlockDeviceRequest -> ShowS

show :: LaunchTemplateEbsBlockDeviceRequest -> String

showList :: [LaunchTemplateEbsBlockDeviceRequest] -> ShowS

NFData LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

rnf :: LaunchTemplateEbsBlockDeviceRequest -> ()

Eq LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

(==) :: LaunchTemplateEbsBlockDeviceRequest -> LaunchTemplateEbsBlockDeviceRequest -> Bool

(/=) :: LaunchTemplateEbsBlockDeviceRequest -> LaunchTemplateEbsBlockDeviceRequest -> Bool

Hashable LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

Methods

hashWithSalt :: Int -> LaunchTemplateEbsBlockDeviceRequest -> Int

hash :: LaunchTemplateEbsBlockDeviceRequest -> Int

type Rep LaunchTemplateEbsBlockDeviceRequest

Defined in Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest

type Rep LaunchTemplateEbsBlockDeviceRequest = D1 ('MetaData "LaunchTemplateEbsBlockDeviceRequest" "Amazonka.EC2.Types.LaunchTemplateEbsBlockDeviceRequest" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "LaunchTemplateEbsBlockDeviceRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deleteOnTermination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "throughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "volumeSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "volumeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeType))))))

newLaunchTemplateEbsBlockDeviceRequest :: LaunchTemplateEbsBlockDeviceRequest

Create a value of LaunchTemplateEbsBlockDeviceRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deleteOnTermination:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

$sel:encrypted:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_encrypted - 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.

$sel:iops:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_iops - 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.

$sel:kmsKeyId:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_kmsKeyId - The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

$sel:snapshotId:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_snapshotId - The ID of the snapshot.

$sel:throughput:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_throughput - 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.

$sel:volumeSize:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_volumeSize - 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

$sel:volumeType:LaunchTemplateEbsBlockDeviceRequest', launchTemplateEbsBlockDeviceRequest_volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

launchTemplateEbsBlockDeviceRequest_deleteOnTermination :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Bool)

Indicates whether the EBS volume is deleted on instance termination.

launchTemplateEbsBlockDeviceRequest_encrypted :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Bool)

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.

launchTemplateEbsBlockDeviceRequest_iops :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Int)

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.

launchTemplateEbsBlockDeviceRequest_kmsKeyId :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Text)

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

launchTemplateEbsBlockDeviceRequest_snapshotId :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Text)

The ID of the snapshot.

launchTemplateEbsBlockDeviceRequest_throughput :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Int)

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.

launchTemplateEbsBlockDeviceRequest_volumeSize :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe Int)

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

launchTemplateEbsBlockDeviceRequest_volumeType :: Lens' LaunchTemplateEbsBlockDeviceRequest (Maybe VolumeType)

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