software.amazon.awssdk.services.ec2.model

Interface LaunchTemplateEbsBlockDeviceRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>, SdkBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>, SdkPojo

Enclosing class:

LaunchTemplateEbsBlockDeviceRequest

public static interface LaunchTemplateEbsBlockDeviceRequest.Builder
extends SdkPojo, CopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>

Method Summary

Modifier and Type	Method and Description
LaunchTemplateEbsBlockDeviceRequest.Builder	deleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
LaunchTemplateEbsBlockDeviceRequest.Builder	encrypted(Boolean encrypted) Indicates whether the EBS volume is encrypted.
LaunchTemplateEbsBlockDeviceRequest.Builder	iops(Integer iops) The number of I/O operations per second (IOPS).
LaunchTemplateEbsBlockDeviceRequest.Builder	kmsKeyId(String kmsKeyId) The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
LaunchTemplateEbsBlockDeviceRequest.Builder	snapshotId(String snapshotId) The ID of the snapshot.
LaunchTemplateEbsBlockDeviceRequest.Builder	throughput(Integer throughput) The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
LaunchTemplateEbsBlockDeviceRequest.Builder	volumeSize(Integer volumeSize) The size of the volume, in GiBs.
LaunchTemplateEbsBlockDeviceRequest.Builder	volumeType(String volumeType) The volume type.
LaunchTemplateEbsBlockDeviceRequest.Builder	volumeType(VolumeType volumeType) The volume type.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

encrypted

LaunchTemplateEbsBlockDeviceRequest.Builder encrypted(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

deleteOnTermination

LaunchTemplateEbsBlockDeviceRequest.Builder deleteOnTermination(Boolean deleteOnTermination)

Indicates whether the EBS volume is deleted on instance termination.

Parameters:

deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

Returns:

Returns a reference to this object so that method calls can be chained together.

iops

LaunchTemplateEbsBlockDeviceRequest.Builder iops(Integer 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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Parameters:

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 required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

LaunchTemplateEbsBlockDeviceRequest.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotId

LaunchTemplateEbsBlockDeviceRequest.Builder snapshotId(String snapshotId)

The ID of the snapshot.

Parameters:

snapshotId - The ID of the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeSize

LaunchTemplateEbsBlockDeviceRequest.Builder volumeSize(Integer volumeSize)

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot 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

Parameters:

volumeSize - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot 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:

Returns a reference to this object so that method calls can be chained together.

volumeType

LaunchTemplateEbsBlockDeviceRequest.Builder volumeType(String volumeType)

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

Parameters:

volumeType - The volume type. The default is gp2. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType, VolumeType

volumeType

LaunchTemplateEbsBlockDeviceRequest.Builder volumeType(VolumeType volumeType)

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

Parameters:

volumeType - The volume type. The default is gp2. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType, VolumeType

throughput

LaunchTemplateEbsBlockDeviceRequest.Builder throughput(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.