public class CreateVolumeRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable, DryRunSupportedRequest<CreateVolumeRequest>
Contains the parameters for CreateVolume.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
availabilityZone
The Availability Zone in which to create the volume.
|
private java.lang.Boolean |
encrypted
Specifies whether the volume should be encrypted.
|
private java.lang.Integer |
iops
Only valid for Provisioned IOPS SSD volumes.
|
private java.lang.String |
kmsKeyId
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) to use when creating the encrypted volume.
|
private java.lang.Integer |
size
The size of the volume, in GiBs.
|
private java.lang.String |
snapshotId
The snapshot from which to create the volume.
|
private java.lang.String |
volumeType
The volume type.
|
NOOP
Constructor and Description |
---|
CreateVolumeRequest()
Default constructor for CreateVolumeRequest object.
|
CreateVolumeRequest(java.lang.Integer size,
java.lang.String availabilityZone)
Constructs a new CreateVolumeRequest object.
|
CreateVolumeRequest(java.lang.String snapshotId,
java.lang.String availabilityZone)
Constructs a new CreateVolumeRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateVolumeRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAvailabilityZone()
The Availability Zone in which to create the volume.
|
Request<CreateVolumeRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.lang.Boolean |
getEncrypted()
Specifies whether the volume should be encrypted.
|
java.lang.Integer |
getIops()
Only valid for Provisioned IOPS SSD volumes.
|
java.lang.String |
getKmsKeyId()
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) to use when creating the encrypted volume.
|
java.lang.Integer |
getSize()
The size of the volume, in GiBs.
|
java.lang.String |
getSnapshotId()
The snapshot from which to create the volume.
|
java.lang.String |
getVolumeType()
The volume type.
|
int |
hashCode() |
java.lang.Boolean |
isEncrypted()
Specifies whether the volume should be encrypted.
|
void |
setAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone in which to create the volume.
|
void |
setEncrypted(java.lang.Boolean encrypted)
Specifies whether the volume should be encrypted.
|
void |
setIops(java.lang.Integer iops)
Only valid for Provisioned IOPS SSD volumes.
|
void |
setKmsKeyId(java.lang.String kmsKeyId)
The full ARN of the AWS Key Management Service (AWS KMS) customer master
key (CMK) to use when creating the encrypted volume.
|
void |
setSize(java.lang.Integer size)
The size of the volume, in GiBs.
|
void |
setSnapshotId(java.lang.String snapshotId)
The snapshot from which to create the volume.
|
void |
setVolumeType(java.lang.String volumeType)
The volume type.
|
void |
setVolumeType(VolumeType volumeType)
The volume type.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateVolumeRequest |
withAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone in which to create the volume.
|
CreateVolumeRequest |
withEncrypted(java.lang.Boolean encrypted)
Specifies whether the volume should be encrypted.
|
CreateVolumeRequest |
withIops(java.lang.Integer iops)
Only valid for Provisioned IOPS SSD volumes.
|
CreateVolumeRequest |
withKmsKeyId(java.lang.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 |
withSize(java.lang.Integer size)
The size of the volume, in GiBs.
|
CreateVolumeRequest |
withSnapshotId(java.lang.String snapshotId)
The snapshot from which to create the volume.
|
CreateVolumeRequest |
withVolumeType(java.lang.String volumeType)
The volume type.
|
CreateVolumeRequest |
withVolumeType(VolumeType volumeType)
The volume type.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.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.
private java.lang.String snapshotId
The snapshot from which to create the volume.
private java.lang.String availabilityZone
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
private java.lang.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
private java.lang.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 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
private java.lang.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.
private java.lang.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.
public CreateVolumeRequest()
public CreateVolumeRequest(java.lang.Integer size, java.lang.String availabilityZone)
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.
availabilityZone
- The Availability Zone in which to create the volume. Use
DescribeAvailabilityZones to list the Availability Zones
that are currently available to you.public CreateVolumeRequest(java.lang.String snapshotId, java.lang.String availabilityZone)
snapshotId
- The snapshot from which to create the volume.availabilityZone
- The Availability Zone in which to create the volume. Use
DescribeAvailabilityZones to list the Availability Zones
that are currently available to you.public void setSize(java.lang.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.
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.
public java.lang.Integer getSize()
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 CreateVolumeRequest withSize(java.lang.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.
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.
public void setSnapshotId(java.lang.String snapshotId)
The snapshot from which to create the volume.
snapshotId
- The snapshot from which to create the volume.public java.lang.String getSnapshotId()
The snapshot from which to create the volume.
public CreateVolumeRequest withSnapshotId(java.lang.String snapshotId)
The snapshot from which to create the volume.
snapshotId
- The snapshot from which to create the volume.public void setAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
availabilityZone
- The Availability Zone in which to create the volume. Use
DescribeAvailabilityZones to list the Availability Zones
that are currently available to you.public java.lang.String getAvailabilityZone()
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
public CreateVolumeRequest withAvailabilityZone(java.lang.String availabilityZone)
The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
availabilityZone
- The Availability Zone in which to create the volume. Use
DescribeAvailabilityZones to list the Availability Zones
that are currently available to you.public void setVolumeType(java.lang.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
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
VolumeType
public java.lang.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: standard
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 CreateVolumeRequest withVolumeType(java.lang.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
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
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: standard
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
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: standard
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
VolumeType
public void setIops(java.lang.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 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
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 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
public java.lang.Integer getIops()
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 30 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 CreateVolumeRequest withIops(java.lang.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 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
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 30 IOPS/GiB.
Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
public void setEncrypted(java.lang.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.
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 java.lang.Boolean getEncrypted()
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 CreateVolumeRequest withEncrypted(java.lang.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.
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 java.lang.Boolean isEncrypted()
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 void setKmsKeyId(java.lang.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.
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.public java.lang.String getKmsKeyId()
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 CreateVolumeRequest withKmsKeyId(java.lang.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.
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.public Request<CreateVolumeRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<CreateVolumeRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateVolumeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()