com.amazonaws.services.ec2.model.EbsBlockDevice Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2014 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;
/**
*
* Describes an Amazon EBS block device.
*
*/
public class EbsBlockDevice implements Serializable {
/**
* The ID of the snapshot.
*/
private String snapshotId;
/**
* The size of the volume, in GiB. Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you
* specify a snapshot, the volume size must be equal to or larger than
* the snapshot size.
Default: If you're creating the volume from a
* snapshot and don't specify a volume size, the default is the snapshot
* size.
*/
private Integer volumeSize;
/**
* Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*/
private Boolean deleteOnTermination;
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* Constraints:
* Allowed Values: standard, io1, gp2
*/
private String volumeType;
/**
* The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*/
private Integer iops;
/**
* Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*/
private Boolean encrypted;
/**
* The ID of the snapshot.
*
* @return The ID of the snapshot.
*/
public String getSnapshotId() {
return snapshotId;
}
/**
* The ID of the snapshot.
*
* @param snapshotId The ID of the snapshot.
*/
public void setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
}
/**
* The ID of the snapshot.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotId The ID of the snapshot.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EbsBlockDevice withSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
return this;
}
/**
* The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. 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.
*
* @return The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you
* specify a snapshot, the volume size must be equal to or larger than
* the snapshot size.
Default: If you're creating the volume from a
* snapshot and don't specify a volume size, the default is the snapshot
* size.
*/
public Integer getVolumeSize() {
return volumeSize;
}
/**
* The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. 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.
*
* @param volumeSize The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you
* specify a snapshot, the volume size must be equal to or larger than
* the snapshot size.
Default: If you're creating the volume from a
* snapshot and don't specify a volume size, the default is the snapshot
* size.
*/
public void setVolumeSize(Integer volumeSize) {
this.volumeSize = volumeSize;
}
/**
* The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. 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.
*
* @param volumeSize The size of the volume, in GiB.
Constraints: If the volume type is
* io1, the minimum size of the volume is 10 GiB; otherwise,
* the minimum size is 1 GiB. The maximum volume size is 1024 GiB. 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EbsBlockDevice withVolumeSize(Integer volumeSize) {
this.volumeSize = volumeSize;
return this;
}
/**
* Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*
* @return Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*/
public Boolean isDeleteOnTermination() {
return deleteOnTermination;
}
/**
* Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*
* @param deleteOnTermination Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*/
public void setDeleteOnTermination(Boolean deleteOnTermination) {
this.deleteOnTermination = deleteOnTermination;
}
/**
* Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param deleteOnTermination Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EbsBlockDevice withDeleteOnTermination(Boolean deleteOnTermination) {
this.deleteOnTermination = deleteOnTermination;
return this;
}
/**
* Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*
* @return Indicates whether the Amazon EBS volume is deleted on instance
* termination.
*/
public Boolean getDeleteOnTermination() {
return deleteOnTermination;
}
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* Constraints:
* Allowed Values: standard, io1, gp2
*
* @return The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* @see VolumeType
*/
public String getVolumeType() {
return volumeType;
}
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* Constraints:
* Allowed Values: standard, io1, gp2
*
* @param volumeType The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* @see VolumeType
*/
public void setVolumeType(String volumeType) {
this.volumeType = volumeType;
}
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* 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
*
* @param volumeType The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see VolumeType
*/
public EbsBlockDevice withVolumeType(String volumeType) {
this.volumeType = volumeType;
return this;
}
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* Constraints:
* Allowed Values: standard, io1, gp2
*
* @param volumeType The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* @see VolumeType
*/
public void setVolumeType(VolumeType volumeType) {
this.volumeType = volumeType.toString();
}
/**
* The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* 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
*
* @param volumeType The volume type. gp2 for General Purpose (SSD) volumes,
* io1 for Provisioned IOPS (SSD) volumes, and
* standard for Magnetic volumes.
Default:
* standard
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see VolumeType
*/
public EbsBlockDevice withVolumeType(VolumeType volumeType) {
this.volumeType = volumeType.toString();
return this;
}
/**
* The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*
* @return The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*/
public Integer getIops() {
return iops;
}
/**
* The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*
* @param iops The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*/
public void setIops(Integer iops) {
this.iops = iops;
}
/**
* The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param iops The number of I/O operations per second (IOPS) that the volume
* supports. For Provisioned IOPS (SSD) volumes, this represents the
* number of IOPS that are provisioned for the volume. For General
* Purpose (SSD) volumes, this represents the baseline performance of the
* volume and the rate at which the volume accumulates I/O credits for
* bursting. For more information on General Purpose (SSD) baseline
* performance, I/O credits, and bursting, see Amazon
* EBS Volume Types in the Amazon Elastic Compute Cloud User
* Guide.
Constraint: Range is 100 to 4000 for Provisioned IOPS
* (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
*
Condition: This parameter is required for requests to create
* io1 volumes; it is not used in requests to create
* standard or gp2 volumes.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EbsBlockDevice withIops(Integer iops) {
this.iops = iops;
return this;
}
/**
* Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*
* @return Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*/
public Boolean isEncrypted() {
return encrypted;
}
/**
* Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*
* @param encrypted Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = encrypted;
}
/**
* Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param encrypted Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public EbsBlockDevice withEncrypted(Boolean encrypted) {
this.encrypted = encrypted;
return this;
}
/**
* Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*
* @return Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon
* EBS volumes may only be attached to instances that support Amazon EBS
* encryption.
*/
public Boolean getEncrypted() {
return encrypted;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getSnapshotId() + ",");
if (getVolumeSize() != null) sb.append("VolumeSize: " + getVolumeSize() + ",");
if (isDeleteOnTermination() != null) sb.append("DeleteOnTermination: " + isDeleteOnTermination() + ",");
if (getVolumeType() != null) sb.append("VolumeType: " + getVolumeType() + ",");
if (getIops() != null) sb.append("Iops: " + getIops() + ",");
if (isEncrypted() != null) sb.append("Encrypted: " + isEncrypted() );
sb.append("}");
return sb.toString();
}
@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 + ((isDeleteOnTermination() == null) ? 0 : isDeleteOnTermination().hashCode());
hashCode = prime * hashCode + ((getVolumeType() == null) ? 0 : getVolumeType().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((isEncrypted() == null) ? 0 : isEncrypted().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof EbsBlockDevice == false) return false;
EbsBlockDevice other = (EbsBlockDevice)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.isDeleteOnTermination() == null ^ this.isDeleteOnTermination() == null) return false;
if (other.isDeleteOnTermination() != null && other.isDeleteOnTermination().equals(this.isDeleteOnTermination()) == 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.getIops() == null ^ this.getIops() == null) return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false) return false;
if (other.isEncrypted() == null ^ this.isEncrypted() == null) return false;
if (other.isEncrypted() != null && other.isEncrypted().equals(this.isEncrypted()) == false) return false;
return true;
}
}