com.amazonaws.services.ec2.model

Class CreateVolumeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVolumeRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateVolumeRequest>, java.io.Serializable, java.lang.Cloneable

public class CreateVolumeRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<CreateVolumeRequest>

Container for the parameters to the CreateVolume operation.

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints .

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.createVolume(CreateVolumeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateVolumeRequest() Default constructor for a new 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.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVolumeRequest

public CreateVolumeRequest()

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

CreateVolumeRequest

public CreateVolumeRequest(java.lang.Integer size,
                           java.lang.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.

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.

CreateVolumeRequest

public CreateVolumeRequest(java.lang.String snapshotId,
                           java.lang.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.

availabilityZone - The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

Method Detail

getSize

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.

Returns:

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.

setSize

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.

Parameters:

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.

withSize

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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotId

public java.lang.String getSnapshotId()

The snapshot from which to create the volume.

Returns:

The snapshot from which to create the volume.

setSnapshotId

public void setSnapshotId(java.lang.String snapshotId)

The snapshot from which to create the volume.

Parameters:

snapshotId - The snapshot from which to create the volume.

withSnapshotId

public CreateVolumeRequest withSnapshotId(java.lang.String snapshotId)

The snapshot from which to create the volume.

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

Parameters:

snapshotId - The snapshot from which to create the volume.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

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.

Returns:

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

setAvailabilityZone

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.

Parameters:

availabilityZone - The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

withAvailabilityZone

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.

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

Parameters:

availabilityZone - The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumeType

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

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Returns:

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

See Also:

VolumeType

setVolumeType

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

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Parameters:

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

See Also:

VolumeType

withVolumeType

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

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

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeType

setVolumeType

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

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Parameters:

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

See Also:

VolumeType

withVolumeType

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

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

Constraints:
Allowed Values: standard, io1, gp2, sc1, st1

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VolumeType

getIops

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

Returns:

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

setIops

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

Parameters:

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

withIops

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

isEncrypted

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.

Returns:

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.

setEncrypted

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.

Parameters:

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.

withEncrypted

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.

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

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getEncrypted

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.

Returns:

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.

getKmsKeyId

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.

Returns:

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.

setKmsKeyId

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.

Parameters:

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.

withKmsKeyId

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.

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

Parameters:

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.

Returns:

A reference to this updated 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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object