Package software.amazon.awssdk.services.ec2.model

Interface CreateVolumeRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>, SdkBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>

Enclosing class:

CreateVolumeRequest

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

Method Summary

Modifier and Type	Method	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)	Only valid for Provisioned IOPS SSD volumes.
CreateVolumeRequest.Builder	kmsKeyId(String kmsKeyId)	The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.
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(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.utils.builder.CopyableBuilder

copy

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

apply, build

Method Detail

availabilityZone

CreateVolumeRequest.Builder availabilityZone(String availabilityZone)

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

Parameters:

availabilityZone - The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

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. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Parameters:

encrypted - Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

iops

CreateVolumeRequest.Builder iops(Integer iops)

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

Parameters:

iops - Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

Returns:

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

kmsKeyId

CreateVolumeRequest.Builder kmsKeyId(String kmsKeyId)

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

Parameters:

kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

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.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 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.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 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.

Parameters:

snapshotId - The snapshot from which to create the volume.

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 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

Parameters:

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

Default: standard

Returns:

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

See Also:

VolumeType

volumeType

CreateVolumeRequest.Builder volumeType(VolumeType volumeType)

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

Default: standard

Parameters:

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

Default: standard

Returns:

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

See Also:

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.

NOTE: This method appends the values to the existing list (if any). Use #setTagSpecifications(java.util.Collection) or #withTagSpecifications(java.util.Collection) if you want to override the existing values.

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.