* Describes information used to set up an Amazon EBS volume specified in a block device mapping. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Ebs implements Serializable, Cloneable { /** ** The snapshot ID of the volume to use. *
*
* You must specify either a VolumeSize or a SnapshotId.
*
* The volume size, in GiBs. The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
* the snapshot.
*
* The volume type. For more information, see Amazon EBS volume types in the * Amazon EC2 User Guide for Linux Instances. *
*
* Valid values: standard | io1 | gp2 | st1 | sc1 |
* gp3
*
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
* is true.
*
* The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3
* and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required only
* when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*
* Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that * support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported * instance types. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. * Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the * Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was * encrypted. *
** For more information, see Use * Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide. *
*
* The throughput (MiBps) to provision for a gp3 volume.
*
* The snapshot ID of the volume to use. *
*
* You must specify either a VolumeSize or a SnapshotId.
*
* You must specify either a VolumeSize or a SnapshotId.
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
*
* The snapshot ID of the volume to use. *
*
* You must specify either a VolumeSize or a SnapshotId.
*
* You must specify either a VolumeSize or a SnapshotId.
*/
public String getSnapshotId() {
return this.snapshotId;
}
/**
*
* The snapshot ID of the volume to use. *
*
* You must specify either a VolumeSize or a SnapshotId.
*
* You must specify either a VolumeSize or a SnapshotId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withSnapshotId(String snapshotId) {
setSnapshotId(snapshotId);
return this;
}
/**
*
* The volume size, in GiBs. The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
* the snapshot.
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the
* size of the snapshot.
*/
public void setVolumeSize(Integer volumeSize) {
this.volumeSize = volumeSize;
}
/**
*
* The volume size, in GiBs. The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
* the snapshot.
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the
* size of the snapshot.
*/
public Integer getVolumeSize() {
return this.volumeSize;
}
/**
*
* The volume size, in GiBs. The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
* the snapshot.
*
* gp2 and gp3: 1-16,384
*
* io1: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* You must specify either a SnapshotId or a VolumeSize. If you specify both
* SnapshotId and VolumeSize, the volume size must be equal or greater than the
* size of the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withVolumeSize(Integer volumeSize) {
setVolumeSize(volumeSize);
return this;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the * Amazon EC2 User Guide for Linux Instances. *
*
* Valid values: standard | io1 | gp2 | st1 | sc1 |
* gp3
*
* Valid values: standard | io1 | gp2 | st1 |
* sc1 | gp3
*/
public void setVolumeType(String volumeType) {
this.volumeType = volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the * Amazon EC2 User Guide for Linux Instances. *
*
* Valid values: standard | io1 | gp2 | st1 | sc1 |
* gp3
*
* Valid values: standard | io1 | gp2 | st1 |
* sc1 | gp3
*/
public String getVolumeType() {
return this.volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the * Amazon EC2 User Guide for Linux Instances. *
*
* Valid values: standard | io1 | gp2 | st1 | sc1 |
* gp3
*
* Valid values: standard | io1 | gp2 | st1 |
* sc1 | gp3
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withVolumeType(String volumeType) {
setVolumeType(volumeType);
return this;
}
/**
*
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
* is true.
*
true.
*/
public void setDeleteOnTermination(Boolean deleteOnTermination) {
this.deleteOnTermination = deleteOnTermination;
}
/**
*
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
* is true.
*
true.
*/
public Boolean getDeleteOnTermination() {
return this.deleteOnTermination;
}
/**
*
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
* is true.
*
true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withDeleteOnTermination(Boolean deleteOnTermination) {
setDeleteOnTermination(deleteOnTermination);
return this;
}
/**
*
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
* is true.
*
true.
*/
public Boolean isDeleteOnTermination() {
return this.deleteOnTermination;
}
/**
*
* The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3
* and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required only
* when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*
gp3 and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required
* only when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*/
public void setIops(Integer iops) {
this.iops = iops;
}
/**
*
* The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3
* and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required only
* when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*
gp3 and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000
* IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required
* only when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*/
public Integer getIops() {
return this.iops;
}
/**
*
* The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3
* and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required only
* when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
*
gp3 and io1 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
*
* For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* Iops is supported when the volume type is gp3 or io1 and required
* only when the volume type is io1. (Not used with standard, gp2,
* st1, or sc1 volumes.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withIops(Integer iops) {
setIops(iops);
return this;
}
/**
*
* Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that * support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported * instance types. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. * Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the * Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was * encrypted. *
** For more information, see Use * Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted * snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using * the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot * was encrypted. *
** For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User * Guide. *
*/ public void setEncrypted(Boolean encrypted) { this.encrypted = encrypted; } /** ** Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that * support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported * instance types. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. * Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the * Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was * encrypted. *
** For more information, see Use * Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted * snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using * the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot * was encrypted. *
** For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling * User Guide. *
*/ public Boolean getEncrypted() { return this.encrypted; } /** ** Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that * support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported * instance types. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. * Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the * Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was * encrypted. *
** For more information, see Use * Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted * snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using * the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot * was encrypted. *
** For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User * Guide. *
* @return Returns a reference to this object so that method calls can be chained together. */ public Ebs withEncrypted(Boolean encrypted) { setEncrypted(encrypted); return this; } /** ** Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that * support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported * instance types. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. * Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the * Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was * encrypted. *
** For more information, see Use * Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide. *
** If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted * snapshot. Also, you cannot specify a KMS key ID when using a launch configuration. *
** If you enable encryption by default, the EBS volumes that you create are always encrypted, either using * the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot * was encrypted. *
** For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling * User Guide. *
*/ public Boolean isEncrypted() { return this.encrypted; } /** *
* The throughput (MiBps) to provision for a gp3 volume.
*
gp3 volume.
*/
public void setThroughput(Integer throughput) {
this.throughput = throughput;
}
/**
*
* The throughput (MiBps) to provision for a gp3 volume.
*
gp3 volume.
*/
public Integer getThroughput() {
return this.throughput;
}
/**
*
* The throughput (MiBps) to provision for a gp3 volume.
*
gp3 volume.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Ebs withThroughput(Integer throughput) {
setThroughput(throughput);
return this;
}
/**
* 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 (getSnapshotId() != null)
sb.append("SnapshotId: ").append(getSnapshotId()).append(",");
if (getVolumeSize() != null)
sb.append("VolumeSize: ").append(getVolumeSize()).append(",");
if (getVolumeType() != null)
sb.append("VolumeType: ").append(getVolumeType()).append(",");
if (getDeleteOnTermination() != null)
sb.append("DeleteOnTermination: ").append(getDeleteOnTermination()).append(",");
if (getIops() != null)
sb.append("Iops: ").append(getIops()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted()).append(",");
if (getThroughput() != null)
sb.append("Throughput: ").append(getThroughput());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Ebs == false)
return false;
Ebs other = (Ebs) obj;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null)
return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false)
return false;
if (other.getVolumeSize() == null ^ this.getVolumeSize() == null)
return false;
if (other.getVolumeSize() != null && other.getVolumeSize().equals(this.getVolumeSize()) == 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.getDeleteOnTermination() == null ^ this.getDeleteOnTermination() == null)
return false;
if (other.getDeleteOnTermination() != null && other.getDeleteOnTermination().equals(this.getDeleteOnTermination()) == 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.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
if (other.getThroughput() == null ^ this.getThroughput() == null)
return false;
if (other.getThroughput() != null && other.getThroughput().equals(this.getThroughput()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((getVolumeSize() == null) ? 0 : getVolumeSize().hashCode());
hashCode = prime * hashCode + ((getVolumeType() == null) ? 0 : getVolumeType().hashCode());
hashCode = prime * hashCode + ((getDeleteOnTermination() == null) ? 0 : getDeleteOnTermination().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
hashCode = prime * hashCode + ((getThroughput() == null) ? 0 : getThroughput().hashCode());
return hashCode;
}
@Override
public Ebs clone() {
try {
return (Ebs) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}