software.amazon.awssdk.services.ec2.model

Interface EbsBlockDevice.Builder

All Superinterfaces:

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

Enclosing class:

EbsBlockDevice

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

Method Summary

Modifier and Type	Method and Description
EbsBlockDevice.Builder	deleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
EbsBlockDevice.Builder	encrypted(Boolean encrypted) Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
EbsBlockDevice.Builder	iops(Integer iops) The number of I/O operations per second (IOPS).
EbsBlockDevice.Builder	kmsKeyId(String kmsKeyId) Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
EbsBlockDevice.Builder	outpostArn(String outpostArn) The ARN of the Outpost on which the snapshot is stored.
EbsBlockDevice.Builder	snapshotId(String snapshotId) The ID of the snapshot.
EbsBlockDevice.Builder	throughput(Integer throughput) The throughput that the volume supports, in MiB/s.
EbsBlockDevice.Builder	volumeSize(Integer volumeSize) The size of the volume, in GiBs.
EbsBlockDevice.Builder	volumeType(String volumeType) The volume type.
EbsBlockDevice.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

deleteOnTermination

EbsBlockDevice.Builder deleteOnTermination(Boolean deleteOnTermination)

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

Parameters:

deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

Returns:

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

iops

EbsBlockDevice.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.

snapshotId

EbsBlockDevice.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

EbsBlockDevice.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

EbsBlockDevice.Builder volumeType(String volumeType)

The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.

Returns:

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

See Also:

VolumeType, VolumeType

volumeType

EbsBlockDevice.Builder volumeType(VolumeType volumeType)

The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.

Returns:

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

See Also:

VolumeType, VolumeType

kmsKeyId

EbsBlockDevice.Builder kmsKeyId(String kmsKeyId)

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Parameters:

kmsKeyId - Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Returns:

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

throughput

EbsBlockDevice.Builder throughput(Integer throughput)

The throughput that the volume supports, in MiB/s.

This parameter is valid only for gp3 volumes.

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

Parameters:

throughput - The throughput that the volume supports, in MiB/s.

This parameter is valid only for gp3 volumes.

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.

outpostArn

EbsBlockDevice.Builder outpostArn(String outpostArn)

The ARN of the Outpost on which the snapshot is stored.

This parameter is only supported on BlockDeviceMapping objects called by CreateImage.

Parameters:

outpostArn - The ARN of the Outpost on which the snapshot is stored.

This parameter is only supported on BlockDeviceMapping objects called by CreateImage.

Returns:

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

encrypted

EbsBlockDevice.Builder encrypted(Boolean encrypted)

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by DescribeImageAttribute.

For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.

• If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).

• If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.

• If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.

• If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

Parameters:

encrypted - Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by DescribeImageAttribute.

For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.

• If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).

• If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.

• If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.

• If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

Returns:

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