com.amazonaws.services.ec2.model

Class CreateVolumeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVolumeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateVolumeRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateVolumeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateVolumeRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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.

Method Summary

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 ID of the Availability Zone in which to create the volume.
String	getClientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Request<CreateVolumeRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getEncrypted() Indicates whether the volume should be encrypted.
Integer	getIops() The number of I/O operations per second (IOPS).
String	getKmsKeyId() The identifier of the KMS key to use for Amazon EBS encryption.
Boolean	getMultiAttachEnabled() Indicates whether to enable Amazon EBS Multi-Attach.
String	getOutpostArn() The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
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.
Integer	getThroughput() The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
String	getVolumeType() The volume type.
int	hashCode()
Boolean	isEncrypted() Indicates whether the volume should be encrypted.
Boolean	isMultiAttachEnabled() Indicates whether to enable Amazon EBS Multi-Attach.
void	setAvailabilityZone(String availabilityZone) The ID of the Availability Zone in which to create the volume.
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setEncrypted(Boolean encrypted) Indicates whether the volume should be encrypted.
void	setIops(Integer iops) The number of I/O operations per second (IOPS).
void	setKmsKeyId(String kmsKeyId) The identifier of the KMS key to use for Amazon EBS encryption.
void	setMultiAttachEnabled(Boolean multiAttachEnabled) Indicates whether to enable Amazon EBS Multi-Attach.
void	setOutpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
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	setThroughput(Integer throughput) The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
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 ID of the Availability Zone in which to create the volume.
CreateVolumeRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateVolumeRequest	withEncrypted(Boolean encrypted) Indicates whether the volume should be encrypted.
CreateVolumeRequest	withIops(Integer iops) The number of I/O operations per second (IOPS).
CreateVolumeRequest	withKmsKeyId(String kmsKeyId) The identifier of the KMS key to use for Amazon EBS encryption.
CreateVolumeRequest	withMultiAttachEnabled(Boolean multiAttachEnabled) Indicates whether to enable Amazon EBS Multi-Attach.
CreateVolumeRequest	withOutpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
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	withThroughput(Integer throughput) The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
CreateVolumeRequest	withVolumeType(String volumeType) The volume type.
CreateVolumeRequest	withVolumeType(VolumeType volumeType) The volume type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVolumeRequest

public CreateVolumeRequest()

Default constructor for CreateVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

CreateVolumeRequest

public CreateVolumeRequest(Integer size,
                           String availabilityZone)

Constructs a new CreateVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

CreateVolumeRequest

public CreateVolumeRequest(String snapshotId,
                           String availabilityZone)

Constructs a new CreateVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Method Detail

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Parameters:

availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

getAvailabilityZone

public String getAvailabilityZone()

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Returns:

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

withAvailabilityZone

public CreateVolumeRequest withAvailabilityZone(String availabilityZone)

The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Parameters:

availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncrypted

public void setEncrypted(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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Parameters:

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

getEncrypted

public Boolean getEncrypted()

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Returns:

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

withEncrypted

public CreateVolumeRequest withEncrypted(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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Parameters:

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEncrypted

public Boolean isEncrypted()

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

Returns:

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 EBS User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

setIops

public void setIops(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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

Parameters:

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

getIops

public Integer getIops()

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

Returns:

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

withIops

public CreateVolumeRequest withIops(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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

Parameters:

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The identifier of the 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.

Parameters:

kmsKeyId - The identifier of the 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.

getKmsKeyId

public String getKmsKeyId()

The identifier of the 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.

Returns:

The identifier of the 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.

withKmsKeyId

public CreateVolumeRequest withKmsKeyId(String kmsKeyId)

The identifier of the 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.

Parameters:

kmsKeyId - The identifier of the 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutpostArn

public void setOutpostArn(String outpostArn)

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

getOutpostArn

public String getOutpostArn()

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

Returns:

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

withOutpostArn

public CreateVolumeRequest withOutpostArn(String outpostArn)

The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSize

public void setSize(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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

Parameters:

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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

getSize

public Integer getSize()

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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

Returns:

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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

withSize

public CreateVolumeRequest withSize(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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

Parameters:

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 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

Returns:

Returns a reference to this object so that method calls can be chained together.

setSnapshotId

public void setSnapshotId(String snapshotId)

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Parameters:

snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

getSnapshotId

public String getSnapshotId()

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Returns:

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

withSnapshotId

public CreateVolumeRequest withSnapshotId(String snapshotId)

The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Parameters:

snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVolumeType

public void setVolumeType(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 EBS User Guide.

Default: gp2

Parameters:

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 EBS User Guide.

Default: gp2

See Also:

VolumeType

getVolumeType

public String getVolumeType()

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 EBS User Guide.

Default: gp2

Returns:

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 EBS User Guide.

Default: gp2

See Also:

VolumeType

withVolumeType

public CreateVolumeRequest withVolumeType(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 EBS User Guide.

Default: gp2

Parameters:

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 EBS User Guide.

Default: gp2

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType

setVolumeType

public void setVolumeType(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 EBS User Guide.

Default: gp2

Parameters:

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 EBS User Guide.

Default: gp2

See Also:

VolumeType

withVolumeType

public CreateVolumeRequest withVolumeType(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 EBS User Guide.

Default: gp2

Parameters:

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 EBS User Guide.

Default: gp2

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VolumeType

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the volume during creation.

Returns:

The tags to apply to the volume during creation.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the volume during creation.

Parameters:

tagSpecifications - The tags to apply to the volume during creation.

withTagSpecifications

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.

Parameters:

tagSpecifications - The tags to apply to the volume during creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public CreateVolumeRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the volume during creation.

Parameters:

tagSpecifications - The tags to apply to the volume during creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMultiAttachEnabled

public void setMultiAttachEnabled(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 EBS User Guide.

Parameters:

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 EBS User Guide.

getMultiAttachEnabled

public Boolean getMultiAttachEnabled()

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 EBS User Guide.

Returns:

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 EBS User Guide.

withMultiAttachEnabled

public CreateVolumeRequest withMultiAttachEnabled(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 EBS User Guide.

Parameters:

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 EBS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

isMultiAttachEnabled

public Boolean isMultiAttachEnabled()

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 EBS User Guide.

Returns:

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 EBS User Guide.

setThroughput

public void setThroughput(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.

Parameters:

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.

getThroughput

public Integer getThroughput()

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.

Returns:

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.

withThroughput

public CreateVolumeRequest withThroughput(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

withClientToken

public CreateVolumeRequest withClientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<CreateVolumeRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateVolumeRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateVolumeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()