@Generated(value="software.amazon.awssdk:codegen") public final class CreateVolumeRequest extends Ec2Request implements ToCopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>
Contains the parameters for CreateVolume.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateVolumeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
availabilityZone()
The Availability Zone in which to create the volume.
|
static CreateVolumeRequest.Builder |
builder() |
Boolean |
encrypted()
Specifies whether the volume should be encrypted.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
iops()
Only valid for Provisioned IOPS SSD volumes.
|
String |
kmsKeyId()
The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted volume.
|
static Class<? extends CreateVolumeRequest.Builder> |
serializableBuilderClass() |
Integer |
size()
The size of the volume, in GiBs.
|
String |
snapshotId()
The snapshot from which to create the volume.
|
List<TagSpecification> |
tagSpecifications()
The tags to apply to the volume during creation.
|
CreateVolumeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
VolumeType |
volumeType()
The volume type.
|
String |
volumeTypeAsString()
The volume type.
|
overrideConfiguration
copy
public String availabilityZone()
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
public 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.
public 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
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
public 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.
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.public 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.
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.
public String snapshotId()
The snapshot from which to create the volume.
public 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
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeAsString()
.
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
VolumeType
public String volumeTypeAsString()
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
If the service returns an enum value that is not available in the current SDK version, volumeType
will
return VolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
volumeTypeAsString()
.
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
VolumeType
public List<TagSpecification> tagSpecifications()
The tags to apply to the volume during creation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateVolumeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>
toBuilder
in class Ec2Request
public static CreateVolumeRequest.Builder builder()
public static Class<? extends CreateVolumeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.