public static interface CreateVolumeRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateVolumeRequest.Builder |
availabilityZone(String availabilityZone)
The ID of the Availability Zone in which to create the volume.
|
CreateVolumeRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateVolumeRequest.Builder |
encrypted(Boolean encrypted)
Indicates whether the volume should be encrypted.
|
CreateVolumeRequest.Builder |
iops(Integer iops)
The number of I/O operations per second (IOPS).
|
CreateVolumeRequest.Builder |
kmsKeyId(String kmsKeyId)
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
|
CreateVolumeRequest.Builder |
multiAttachEnabled(Boolean multiAttachEnabled)
Indicates 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 |
throughput(Integer throughput)
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
|
CreateVolumeRequest.Builder |
volumeType(String volumeType)
The volume type.
|
CreateVolumeRequest.Builder |
volumeType(VolumeType volumeType)
The volume type.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateVolumeRequest.Builder availabilityZone(String availabilityZone)
The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.CreateVolumeRequest.Builder encrypted(Boolean encrypted)
Indicates 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.
encrypted - Indicates 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.
CreateVolumeRequest.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
io1 and io2 volumes support up to 64,000 IOPS only on Instances
built on the Nitro System. Other instance families support 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.
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
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support 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.
CreateVolumeRequest.Builder kmsKeyId(String kmsKeyId)
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the
encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
kmsKeyId - The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
CreateVolumeRequest.Builder outpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
outpostArn - The Amazon Resource Name (ARN) of the Outpost.CreateVolumeRequest.Builder size(Integer size)
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
size - 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
CreateVolumeRequest.Builder snapshotId(String snapshotId)
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.CreateVolumeRequest.Builder volumeType(String volumeType)
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot
volumes.
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
volumeType - The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as
boot volumes.
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
VolumeType,
VolumeTypeCreateVolumeRequest.Builder volumeType(VolumeType volumeType)
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot
volumes.
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
volumeType - The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as
boot volumes.
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
VolumeType,
VolumeTypeCreateVolumeRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume during creation.
tagSpecifications - The tags to apply to the volume during creation.CreateVolumeRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the volume during creation.
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.
This is a convenience method that creates an instance of theTagSpecification.Builder avoiding the need to create one
manually via TagSpecification.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #tagSpecifications(List.
tagSpecifications - a consumer that will call methods on
TagSpecification.Builder#tagSpecifications(java.util.Collection) CreateVolumeRequest.Builder multiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to
up to 16 Instances
built on the Nitro System in the same Availability Zone. This parameter is supported with
io1 and io2 volumes only. For more information, see Amazon EBS
Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
multiAttachEnabled - Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported
with io1 and io2 volumes only. For more information, see Amazon EBS
Multi-Attach in the Amazon Elastic Compute Cloud User Guide.CreateVolumeRequest.Builder throughput(Integer throughput)
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
throughput - The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
CreateVolumeRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
information, see Ensure
Idempotency.CreateVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.