software.amazon.awssdk.services.ec2.model

Interface CreateVolumeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>, Ec2Request.Builder, SdkBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateVolumeRequest

public static interface CreateVolumeRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>

Method Summary

Modifier and Type	Method and Description
CreateVolumeRequest.Builder	availabilityZone(String availabilityZone) The Availability Zone in which to create the volume.
CreateVolumeRequest.Builder	encrypted(Boolean encrypted) Specifies whether the volume should be encrypted.
CreateVolumeRequest.Builder	iops(Integer iops) The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2.
CreateVolumeRequest.Builder	kmsKeyId(String kmsKeyId) The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
CreateVolumeRequest.Builder	multiAttachEnabled(Boolean multiAttachEnabled) Specifies whether to enable Amazon EBS Multi-Attach.
CreateVolumeRequest.Builder	outpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost.
CreateVolumeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateVolumeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateVolumeRequest.Builder	size(Integer size) The size of the volume, in GiBs.
CreateVolumeRequest.Builder	snapshotId(String snapshotId) The snapshot from which to create the volume.
CreateVolumeRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the volume during creation.
CreateVolumeRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the volume during creation.
CreateVolumeRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the volume during creation.
CreateVolumeRequest.Builder	volumeType(String volumeType) The volume type.
CreateVolumeRequest.Builder	volumeType(VolumeType volumeType) The volume type.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

availabilityZone

CreateVolumeRequest.Builder availabilityZone(String availabilityZone)

The Availability Zone in which to create the volume.

Parameters:

availabilityZone - The Availability Zone in which to create the volume.

Returns:

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

encrypted

CreateVolumeRequest.Builder encrypted(Boolean encrypted)

Specifies whether the volume should be encrypted. 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 Encryption by default in the Amazon Elastic Compute Cloud User Guide.

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

Parameters:

encrypted - Specifies whether the volume should be encrypted. 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 Encryption by default in the Amazon Elastic Compute Cloud User Guide.

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

Returns:

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

iops

CreateVolumeRequest.Builder iops(Integer iops)

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum 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.

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

Parameters:

iops - The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum 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.

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

Returns:

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

kmsKeyId

CreateVolumeRequest.Builder kmsKeyId(String kmsKeyId)

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

• Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Parameters:

kmsKeyId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

• Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Returns:

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

outpostArn

CreateVolumeRequest.Builder outpostArn(String outpostArn)

The Amazon Resource Name (ARN) of the Outpost.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Outpost.

Returns:

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

size

CreateVolumeRequest.Builder size(Integer size)

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

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

Parameters:

size - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

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

Returns:

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

snapshotId

CreateVolumeRequest.Builder snapshotId(String snapshotId)

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Parameters:

snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Returns:

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

volumeType

CreateVolumeRequest.Builder volumeType(String volumeType)

The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Parameters:

volumeType - The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Returns:

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

See Also:

VolumeType, VolumeType

volumeType

CreateVolumeRequest.Builder volumeType(VolumeType volumeType)

The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Parameters:

volumeType - The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

Returns:

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

See Also:

VolumeType, VolumeType

tagSpecifications

CreateVolumeRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the volume during creation.

Parameters:

tagSpecifications - The tags to apply to the volume during creation.

Returns:

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

tagSpecifications

CreateVolumeRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the volume during creation.

Parameters:

tagSpecifications - The tags to apply to the volume during creation.

Returns:

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

tagSpecifications

CreateVolumeRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the volume during creation.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tagSpecifications(List)

multiAttachEnabled

CreateVolumeRequest.Builder multiAttachEnabled(Boolean multiAttachEnabled)

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Parameters:

multiAttachEnabled - Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

overrideConfiguration

CreateVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder