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 Availability Zone in which to create the volume.
|
CreateVolumeRequest.Builder |
encrypted(Boolean encrypted)
Specifies the encryption state of the volume.
|
CreateVolumeRequest.Builder |
iops(Integer iops)
The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50
IOPS/GiB.
|
CreateVolumeRequest.Builder |
kmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the
volume.
|
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.
|
buildoverrideConfigurationcopyapplyMutation, buildCreateVolumeRequest.Builder availabilityZone(String availabilityZone)
The Availability Zone in which to create the volume.
availabilityZone - The Availability Zone in which to create the volume.CreateVolumeRequest.Builder encrypted(Boolean encrypted)
Specifies the encryption state of the volume. The default effect of setting the Encrypted
parameter to true depends on the volume origin (new or from a snapshot), starting encryption
state, ownership, and whether account-level
encryption is enabled. Each default case can be overridden by specifying a customer master key (CMK)
using the KmsKeyId parameter, in addition to setting Encrypted to true
. For a complete list of possible encryption cases, see Amazon
EBS Encryption.
Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.
encrypted - Specifies the encryption state of the volume. The default effect of setting the Encrypted
parameter to true depends on the volume origin (new or from a snapshot), starting
encryption state, ownership, and whether account-level
encryption is enabled. Each default case can be overridden by specifying a customer master key
(CMK) using the KmsKeyId parameter, in addition to setting Encrypted to
true. For a complete list of possible encryption cases, see Amazon EBS Encryption.
Encrypted Amazon EBS volumes may only 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) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. 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) volumes.
iops - The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50
IOPS/GiB. 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) volumes.
CreateVolumeRequest.Builder kmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the
volume. This parameter is only required if you want to use a customer-managed CMK; if this parameter is not
specified, your AWS-managed CMK for the account is used. If a KmsKeyId is specified, the
Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID: For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias: For example, alias/ExampleAlias.
Key ARN: The key 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.
Alias ARN: The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK,
the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates KmsKeyId asynchronously, meaning that the action you call may appear to
complete even though you provided an invalid identifier. The action will eventually fail.
kmsKeyId - An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt
the volume. This parameter is only required if you want to use a customer-managed CMK; if this
parameter is not specified, your AWS-managed CMK for the account is used. If a KmsKeyId
is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID: For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias: For example, alias/ExampleAlias.
Key ARN: The key 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.
Alias ARN: The alias ARN contains the arn:aws:kms namespace, followed by the Region of
the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK
alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates KmsKeyId asynchronously, meaning that the action you call may appear to
complete even though you provided an invalid identifier. The action will eventually fail.
CreateVolumeRequest.Builder size(Integer size)
The size of the volume, in GiBs.
Constraints: 1-16,384 for gp2, 4-16,384 for io1, 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.
At least one of Size or SnapshotId is required.
size - The size of the volume, in GiBs.
Constraints: 1-16,384 for gp2, 4-16,384 for io1, 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.
At least one of Size or SnapshotId is required.
CreateVolumeRequest.Builder snapshotId(String snapshotId)
The snapshot from which to create the volume.
At least one of Size or SnapshotId are required.
snapshotId - The snapshot from which to create the volume. At least one of Size or SnapshotId are required.
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.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
gp2.
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.
Defaults: If no volume type is specified, the default is standard in us-east-1,
eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2,
ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS
defaults to gp2.
VolumeType,
VolumeTypeCreateVolumeRequest.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.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
gp2.
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.
Defaults: If no volume type is specified, the default is standard in us-east-1,
eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2,
ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS
defaults to 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 that creates an instance of theList.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) .tagSpecifications - a consumer that will call methods on List.Builder #tagSpecifications(List) CreateVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2019. All rights reserved.