software.amazon.awssdk.services.autoscaling.model

Interface Ebs.Builder

All Superinterfaces:

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

Enclosing class:

Ebs

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

Method Summary

Modifier and Type	Method and Description
Ebs.Builder	deleteOnTermination(Boolean deleteOnTermination) Indicates whether the volume is deleted on instance termination.
Ebs.Builder	encrypted(Boolean encrypted) Specifies whether the volume should be encrypted.
Ebs.Builder	iops(Integer iops) The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
Ebs.Builder	snapshotId(String snapshotId) The snapshot ID of the volume to use.
Ebs.Builder	throughput(Integer throughput) The throughput (MiBps) to provision for a gp3 volume.
Ebs.Builder	volumeSize(Integer volumeSize) The volume size, in GiBs.
Ebs.Builder	volumeType(String 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

snapshotId

Ebs.Builder snapshotId(String snapshotId)

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Parameters:

snapshotId - The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Returns:

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

volumeSize

Ebs.Builder volumeSize(Integer volumeSize)

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

• gp2 and gp3: 1-16,384

• io1: 4-16,384

• st1 and sc1: 125-16,384

• standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Parameters:

volumeSize - The volume size, in GiBs. The following are the supported volumes sizes for each volume type:

• gp2 and gp3: 1-16,384

• io1: 4-16,384

• st1 and sc1: 125-16,384

• standard: 1-1,024

You must specify either a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.

Returns:

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

volumeType

Ebs.Builder volumeType(String volumeType)

The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Returns:

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

deleteOnTermination

Ebs.Builder deleteOnTermination(Boolean deleteOnTermination)

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Parameters:

deleteOnTermination - Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Returns:

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

iops

Ebs.Builder iops(Integer iops)

The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Parameters:

iops - The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Returns:

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

encrypted

Ebs.Builder encrypted(Boolean encrypted)

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

Parameters:

encrypted - Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.

Returns:

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

throughput

Ebs.Builder throughput(Integer throughput)

The throughput (MiBps) to provision for a gp3 volume.

Parameters:

throughput - The throughput (MiBps) to provision for a gp3 volume.

Returns:

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