com.amazonaws.services.ec2.model.CreateVolumeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.CreateVolumeRequestMarshaller;
/**
*
* Contains the parameters for CreateVolume.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
*
*/
private String availabilityZone;
/**
*
* 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 Boolean encrypted;
/**
*
* 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.
*
*/
private Integer iops;
/**
*
* An identifier for 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. If a KmsKeyId is specified, the Encrypted
* flag must also be set.
*
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the
* CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
* arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
* though you provided an invalid identifier. The action will eventually fail.
*
*/
private String kmsKeyId;
/**
*
* 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 are required.
*
*
*/
private Integer size;
/**
*
* The snapshot from which to create the volume.
*
*
*
* At least one of Size or SnapshotId are required.
*
*
*/
private String snapshotId;
/**
*
* 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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*/
private String volumeType;
/**
*
* The tags to apply to the volume during creation.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
* Default constructor for CreateVolumeRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public CreateVolumeRequest() {
}
/**
* Constructs a new CreateVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param 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 are required.
*
* @param 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(Integer size, String availabilityZone) {
setSize(size);
setAvailabilityZone(availabilityZone);
}
/**
* Constructs a new CreateVolumeRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param snapshotId
* The snapshot from which to create the volume.
*
* At least one of Size or SnapshotId are required.
*
* @param 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(String snapshotId, String availabilityZone) {
setSnapshotId(snapshotId);
setAvailabilityZone(availabilityZone);
}
/**
*
* The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
*
*
* @param 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 setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
*
*
* @return The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
*
*
* @param availabilityZone
* The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the
* Availability Zones that are currently available to you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setEncrypted(Boolean encrypted) {
this.encrypted = 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.
*
*
* @return 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 Boolean getEncrypted() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
return this;
}
/**
*
* 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.
*
*
* @return 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 Boolean isEncrypted() {
return this.encrypted;
}
/**
*
* 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.
*
*
* @param 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 setIops(Integer iops) {
this.iops = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withIops(Integer iops) {
setIops(iops);
return this;
}
/**
*
* An identifier for 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. If a KmsKeyId is specified, the Encrypted
* flag must also be set.
*
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the
* CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
* arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
* though you provided an invalid identifier. The action will eventually fail.
*
*
* @param kmsKeyId
* An identifier for 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. If a KmsKeyId is specified, the
* Encrypted flag must also be set.
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region
* of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias.
* For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete
* even though you provided an invalid identifier. The action will eventually fail.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* An identifier for 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. If a KmsKeyId is specified, the Encrypted
* flag must also be set.
*
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the
* CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
* arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
* though you provided an invalid identifier. The action will eventually fail.
*
*
* @return An identifier for 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. If a KmsKeyId is specified, the
* Encrypted flag must also be set.
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the
* region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the
* CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete
* even though you provided an invalid identifier. The action will eventually fail.
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* An identifier for 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. If a KmsKeyId is specified, the Encrypted
* flag must also be set.
*
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the
* CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
* arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
* though you provided an invalid identifier. The action will eventually fail.
*
*
* @param kmsKeyId
* An identifier for 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. If a KmsKeyId is specified, the
* Encrypted flag must also be set.
*
* The CMK identifier may be provided in any of the following formats:
*
*
* -
*
* Key ID
*
*
* -
*
* Key alias
*
*
* -
*
* ARN using key ID. The ID 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.
*
*
* -
*
* ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region
* of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias.
* For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*
*
*
*
* AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete
* even though you provided an invalid identifier. The action will eventually fail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* 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 are required.
*
*
*
* @param 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 are required.
*
*/
public void setSize(Integer size) {
this.size = 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 are required.
*
*
*
* @return 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 are required.
*
*/
public Integer getSize() {
return this.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 are required.
*
*
*
* @param 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 are required.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withSize(Integer size) {
setSize(size);
return this;
}
/**
*
* The snapshot from which to create the volume.
*
*
*
* At least one of Size or SnapshotId are required.
*
*
*
* @param snapshotId
* The snapshot from which to create the volume.
*
* At least one of Size or SnapshotId are required.
*
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
*
* The snapshot from which to create the volume.
*
*
*
* At least one of Size or SnapshotId are required.
*
*
*
* @return The snapshot from which to create the volume.
*
* At least one of Size or SnapshotId are required.
*
*/
public String getSnapshotId() {
return this.snapshotId;
}
/**
*
* The snapshot from which to create the volume.
*
*
*
* At least one of Size or SnapshotId are required.
*
*
*
* @param snapshotId
* The snapshot from which to create the volume.
*
* At least one of Size or SnapshotId are required.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withSnapshotId(String snapshotId) {
setSnapshotId(snapshotId);
return this;
}
/**
*
* 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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*
* @param 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.
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
* ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
* gp2.
* @see VolumeType
*/
public void setVolumeType(String volumeType) {
this.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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*
* @return 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.
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
* ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
* gp2.
* @see VolumeType
*/
public String getVolumeType() {
return this.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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*
* @param 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.
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
* ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
* gp2.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
public CreateVolumeRequest withVolumeType(String volumeType) {
setVolumeType(volumeType);
return this;
}
/**
*
* 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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*
* @param 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.
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
* ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
* gp2.
* @see VolumeType
*/
public void setVolumeType(VolumeType volumeType) {
withVolumeType(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.
*
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2,
* ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
*
*
* @param 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.
*
* Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1,
* eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1,
* ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to
* gp2.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
public CreateVolumeRequest withVolumeType(VolumeType volumeType) {
this.volumeType = volumeType.toString();
return this;
}
/**
*
* The tags to apply to the volume during creation.
*
*
* @return The tags to apply to the volume during creation.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the volume during creation.
*
*
* @param tagSpecifications
* The tags to apply to the volume during creation.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the volume during creation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the volume during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the volume during creation.
*
*
* @param tagSpecifications
* The tags to apply to the volume during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateVolumeRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new CreateVolumeRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted()).append(",");
if (getIops() != null)
sb.append("Iops: ").append(getIops()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getSize() != null)
sb.append("Size: ").append(getSize()).append(",");
if (getSnapshotId() != null)
sb.append("SnapshotId: ").append(getSnapshotId()).append(",");
if (getVolumeType() != null)
sb.append("VolumeType: ").append(getVolumeType()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateVolumeRequest == false)
return false;
CreateVolumeRequest other = (CreateVolumeRequest) obj;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
if (other.getIops() == null ^ this.getIops() == null)
return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getSize() == null ^ this.getSize() == null)
return false;
if (other.getSize() != null && other.getSize().equals(this.getSize()) == false)
return false;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null)
return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false)
return false;
if (other.getVolumeType() == null ^ this.getVolumeType() == null)
return false;
if (other.getVolumeType() != null && other.getVolumeType().equals(this.getVolumeType()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getSize() == null) ? 0 : getSize().hashCode());
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((getVolumeType() == null) ? 0 : getVolumeType().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
return hashCode;
}
@Override
public CreateVolumeRequest clone() {
return (CreateVolumeRequest) super.clone();
}
}