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) that the volume supports.
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	snapshotId(String snapshotId) The ID of the snapshot.
EbsBlockDevice.Builder	volumeSize(Integer volumeSize) The size of the volume, in GiB.
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 Elastic Compute Cloud 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 Elastic Compute Cloud 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) that the volume supports. For 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

Parameters:

iops - The number of I/O operations per second (IOPS) that the volume supports. For 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create 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 GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD ( io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Parameters:

volumeSize - The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD ( io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Returns:

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

volumeType

EbsBlockDevice.Builder volumeType(String volumeType)

The volume type. If you set the type to io1, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

Default: gp2

Parameters:

volumeType - The volume type. If you set the type to io1, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

Default: gp2

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. If you set the type to io1, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

Default: gp2

Parameters:

volumeType - The volume type. If you set the type to io1, you must also specify the Iops parameter. If you set the type to gp2, st1, sc1, or standard, you must omit the Iops parameter.

Default: gp2

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.

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 Elastic Compute Cloud 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 .

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 Elastic Compute Cloud 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 .

Returns:

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