Class EbsBlockDevice

java.lang.Object
com.amazonaws.services.ec2.model.EbsBlockDevice
All Implemented Interfaces:
Serializable, Cloneable

public class EbsBlockDevice extends Object implements Serializable, Cloneable

Describes a block device for an EBS volume.

See Also:
  • Constructor Details

    • EbsBlockDevice

      public EbsBlockDevice()
  • Method Details

    • setSnapshotId

      public void setSnapshotId(String snapshotId)

      The ID of the snapshot.

      Parameters:
      snapshotId - The ID of the snapshot.
    • getSnapshotId

      public String getSnapshotId()

      The ID of the snapshot.

      Returns:
      The ID of the snapshot.
    • withSnapshotId

      public EbsBlockDevice withSnapshotId(String snapshotId)

      The ID of the snapshot.

      Parameters:
      snapshotId - The ID of the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVolumeSize

      public void setVolumeSize(Integer volumeSize)

      The size of the volume, in GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) volumes. 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:
      volumeSize - The size of the volume, in GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic ( standard) volumes. 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.

    • getVolumeSize

      public Integer getVolumeSize()

      The size of the volume, in GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) volumes. 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 GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic ( standard) volumes. 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.

    • withVolumeSize

      public EbsBlockDevice withVolumeSize(Integer volumeSize)

      The size of the volume, in GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) volumes. 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:
      volumeSize - The size of the volume, in GiB.

      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic ( standard) volumes. 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:
      Returns a reference to this object so that method calls can be chained together.
    • setDeleteOnTermination

      public void setDeleteOnTermination(Boolean deleteOnTermination)

      Indicates whether the EBS volume is deleted on instance termination.

      Parameters:
      deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.
    • getDeleteOnTermination

      public Boolean getDeleteOnTermination()

      Indicates whether the EBS volume is deleted on instance termination.

      Returns:
      Indicates whether the EBS volume is deleted on instance termination.
    • withDeleteOnTermination

      public EbsBlockDevice withDeleteOnTermination(Boolean deleteOnTermination)

      Indicates whether the EBS volume is deleted on instance termination.

      Parameters:
      deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isDeleteOnTermination

      public Boolean isDeleteOnTermination()

      Indicates whether the EBS volume is deleted on instance termination.

      Returns:
      Indicates whether the EBS volume is deleted on instance termination.
    • setVolumeType

      public void setVolumeType(String volumeType)

      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Parameters:
      volumeType - The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      See Also:
    • getVolumeType

      public String getVolumeType()

      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Returns:
      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      See Also:
    • withVolumeType

      public EbsBlockDevice withVolumeType(String volumeType)

      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Parameters:
      volumeType - The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setVolumeType

      public void setVolumeType(VolumeType volumeType)

      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Parameters:
      volumeType - The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      See Also:
    • withVolumeType

      public EbsBlockDevice withVolumeType(VolumeType volumeType)

      The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Parameters:
      volumeType - The volume type: gp2, io1, st1, sc1, or standard.

      Default: standard

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setIops

      public void setIops(Integer iops)

      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

      Parameters:
      iops - The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

    • getIops

      public Integer getIops()

      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

      Returns:
      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

    • withIops

      public EbsBlockDevice withIops(Integer iops)

      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

      Parameters:
      iops - The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, 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-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

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

      public void setEncrypted(Boolean encrypted)

      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

      Parameters:
      encrypted - Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    • getEncrypted

      public Boolean getEncrypted()

      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

      Returns:
      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    • withEncrypted

      public EbsBlockDevice withEncrypted(Boolean encrypted)

      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

      Parameters:
      encrypted - Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isEncrypted

      public Boolean isEncrypted()

      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

      Returns:
      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public EbsBlockDevice clone()
      Overrides:
      clone in class Object