@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<CreateVolumeRequest>
NOOP
Constructor and Description |
---|
CreateVolumeRequest()
Default constructor for CreateVolumeRequest object.
|
CreateVolumeRequest(Integer size,
String availabilityZone)
Constructs a new CreateVolumeRequest object.
|
CreateVolumeRequest(String snapshotId,
String availabilityZone)
Constructs a new CreateVolumeRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateVolumeRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAvailabilityZone()
The Availability Zone in which to create the volume.
|
Request<CreateVolumeRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
Boolean |
getEncrypted()
Specifies whether the volume should be encrypted.
|
Integer |
getIops()
The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.
|
String |
getKmsKeyId()
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption.
|
String |
getOutpostArn()
The Amazon Resource Name (ARN) of the Outpost.
|
Integer |
getSize()
The size of the volume, in GiBs.
|
String |
getSnapshotId()
The snapshot from which to create the volume.
|
List<TagSpecification> |
getTagSpecifications()
The tags to apply to the volume during creation.
|
String |
getVolumeType()
The volume type.
|
int |
hashCode() |
Boolean |
isEncrypted()
Specifies whether the volume should be encrypted.
|
void |
setAvailabilityZone(String availabilityZone)
The Availability Zone in which to create the volume.
|
void |
setEncrypted(Boolean encrypted)
Specifies whether the volume should be encrypted.
|
void |
setIops(Integer iops)
The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.
|
void |
setKmsKeyId(String kmsKeyId)
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption.
|
void |
setOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
|
void |
setSize(Integer size)
The size of the volume, in GiBs.
|
void |
setSnapshotId(String snapshotId)
The snapshot from which to create the volume.
|
void |
setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume during creation.
|
void |
setVolumeType(String volumeType)
The volume type.
|
void |
setVolumeType(VolumeType volumeType)
The volume type.
|
String |
toString()
Returns a string representation of this object.
|
CreateVolumeRequest |
withAvailabilityZone(String availabilityZone)
The Availability Zone in which to create the volume.
|
CreateVolumeRequest |
withEncrypted(Boolean encrypted)
Specifies whether the volume should be encrypted.
|
CreateVolumeRequest |
withIops(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 |
withKmsKeyId(String kmsKeyId)
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
encryption.
|
CreateVolumeRequest |
withOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
|
CreateVolumeRequest |
withSize(Integer size)
The size of the volume, in GiBs.
|
CreateVolumeRequest |
withSnapshotId(String snapshotId)
The snapshot from which to create the volume.
|
CreateVolumeRequest |
withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume during creation.
|
CreateVolumeRequest |
withTagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the volume during creation.
|
CreateVolumeRequest |
withVolumeType(String volumeType)
The volume type.
|
CreateVolumeRequest |
withVolumeType(VolumeType volumeType)
The volume type.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateVolumeRequest()
public CreateVolumeRequest(Integer size, String availabilityZone)
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.
availabilityZone
- The Availability Zone in which to create the volume.public CreateVolumeRequest(String snapshotId, String availabilityZone)
snapshotId
- The snapshot from which to create the volume. At least one of Size or SnapshotId are required.
availabilityZone
- The Availability Zone in which to create the volume.public void setAvailabilityZone(String availabilityZone)
The Availability Zone in which to create the volume.
availabilityZone
- The Availability Zone in which to create the volume.public String getAvailabilityZone()
The Availability Zone in which to create the volume.
public CreateVolumeRequest withAvailabilityZone(String availabilityZone)
The Availability Zone in which to create the volume.
availabilityZone
- The Availability Zone in which to create the volume.public void setEncrypted(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.
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.
public Boolean getEncrypted()
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.
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.
public CreateVolumeRequest withEncrypted(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.
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.
public Boolean isEncrypted()
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.
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.
public void setIops(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.
public Integer getIops()
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.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
public CreateVolumeRequest withIops(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.
public void setKmsKeyId(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.
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.
public String getKmsKeyId()
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.
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.
public CreateVolumeRequest withKmsKeyId(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.
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.
public void setOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
outpostArn
- The Amazon Resource Name (ARN) of the Outpost.public String getOutpostArn()
The Amazon Resource Name (ARN) of the Outpost.
public CreateVolumeRequest withOutpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
outpostArn
- The Amazon Resource Name (ARN) of the Outpost.public void setSize(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.
public Integer getSize()
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.
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.
public CreateVolumeRequest withSize(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.
public void setSnapshotId(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.
public String getSnapshotId()
The snapshot from which to create the volume.
At least one of Size or SnapshotId are required.
At least one of Size or SnapshotId are required.
public CreateVolumeRequest withSnapshotId(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.
public void setVolumeType(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: 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.
Default: gp2
VolumeType
public String getVolumeType()
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: gp2
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: gp2
VolumeType
public CreateVolumeRequest withVolumeType(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: 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.
Default: gp2
VolumeType
public void setVolumeType(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: 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.
Default: gp2
VolumeType
public CreateVolumeRequest withVolumeType(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: 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.
Default: gp2
VolumeType
public List<TagSpecification> getTagSpecifications()
The tags to apply to the volume during creation.
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume during creation.
tagSpecifications
- The tags to apply to the volume during creation.public CreateVolumeRequest withTagSpecifications(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.
tagSpecifications
- The tags to apply to the volume during creation.public CreateVolumeRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the volume during creation.
tagSpecifications
- The tags to apply to the volume during creation.public Request<CreateVolumeRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<CreateVolumeRequest>
public String toString()
toString
in class Object
Object.toString()
public CreateVolumeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.