com.amazonaws.services.autoscaling.model

Class Ebs

java.lang.Object

com.amazonaws.services.autoscaling.model.Ebs

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Ebs
extends Object
implements Serializable, Cloneable

Describes information used to set up an Amazon EBS volume specified in a block device mapping.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Ebs()

Method Summary

Modifier and Type	Method and Description
Ebs	clone()
boolean	equals(Object obj)
Boolean	getDeleteOnTermination() Indicates whether the volume is deleted on instance termination.
Boolean	getEncrypted() Specifies whether the volume should be encrypted.
Integer	getIops() The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
String	getSnapshotId() The snapshot ID of the volume to use.
Integer	getThroughput() The throughput (MiBps) to provision for a gp3 volume.
Integer	getVolumeSize() The volume size, in GiBs.
String	getVolumeType() The volume type.
int	hashCode()
Boolean	isDeleteOnTermination() Indicates whether the volume is deleted on instance termination.
Boolean	isEncrypted() Specifies whether the volume should be encrypted.
void	setDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the volume is deleted on instance termination.
void	setEncrypted(Boolean encrypted) Specifies whether the volume should be encrypted.
void	setIops(Integer iops) The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
void	setSnapshotId(String snapshotId) The snapshot ID of the volume to use.
void	setThroughput(Integer throughput) The throughput (MiBps) to provision for a gp3 volume.
void	setVolumeSize(Integer volumeSize) The volume size, in GiBs.
void	setVolumeType(String volumeType) The volume type.
String	toString() Returns a string representation of this object.
Ebs	withDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the volume is deleted on instance termination.
Ebs	withEncrypted(Boolean encrypted) Specifies whether the volume should be encrypted.
Ebs	withIops(Integer iops) The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
Ebs	withSnapshotId(String snapshotId) The snapshot ID of the volume to use.
Ebs	withThroughput(Integer throughput) The throughput (MiBps) to provision for a gp3 volume.
Ebs	withVolumeSize(Integer volumeSize) The volume size, in GiBs.
Ebs	withVolumeType(String volumeType) The volume type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ebs

public Ebs()

Method Detail

setSnapshotId

public void setSnapshotId(String snapshotId)

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Parameters:

snapshotId - The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

getSnapshotId

public String getSnapshotId()

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Returns:

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

withSnapshotId

public Ebs withSnapshotId(String snapshotId)

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Parameters:

snapshotId - The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

Returns:

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

setVolumeSize

public void setVolumeSize(Integer 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.

Parameters:

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.

getVolumeSize

public Integer getVolumeSize()

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.

Returns:

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.

withVolumeSize

public Ebs withVolumeSize(Integer 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.

Parameters:

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.

Returns:

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

setVolumeType

public void setVolumeType(String volumeType)

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

getVolumeType

public String getVolumeType()

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Returns:

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

withVolumeType

public Ebs withVolumeType(String volumeType)

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

Returns:

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

setDeleteOnTermination

public void setDeleteOnTermination(Boolean deleteOnTermination)

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Parameters:

deleteOnTermination - Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

getDeleteOnTermination

public Boolean getDeleteOnTermination()

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Returns:

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

withDeleteOnTermination

public Ebs withDeleteOnTermination(Boolean deleteOnTermination)

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Parameters:

deleteOnTermination - Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Returns:

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

isDeleteOnTermination

public Boolean isDeleteOnTermination()

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

Returns:

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

setIops

public void setIops(Integer 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 Amazon Web Services 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.)

Parameters:

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 Amazon Web Services 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.)

getIops

public Integer getIops()

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 Amazon Web Services 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.)

Returns:

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 Amazon Web Services 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.)

withIops

public Ebs withIops(Integer 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 Amazon Web Services 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.)

Parameters:

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 Amazon Web Services 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.)

Returns:

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

setEncrypted

public void setEncrypted(Boolean 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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

Parameters:

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

getEncrypted

public Boolean getEncrypted()

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

Returns:

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

withEncrypted

public Ebs withEncrypted(Boolean 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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

Parameters:

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

Returns:

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

isEncrypted

public Boolean isEncrypted()

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

Returns:

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 Requirements for Amazon EBS encryption in the Amazon EBS User Guide. 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.

setThroughput

public void setThroughput(Integer throughput)

The throughput (MiBps) to provision for a gp3 volume.

Parameters:

throughput - The throughput (MiBps) to provision for a gp3 volume.

getThroughput

public Integer getThroughput()

The throughput (MiBps) to provision for a gp3 volume.

Returns:

The throughput (MiBps) to provision for a gp3 volume.

withThroughput

public Ebs withThroughput(Integer throughput)

The throughput (MiBps) to provision for a gp3 volume.

Parameters:

throughput - The throughput (MiBps) to provision for a gp3 volume.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Ebs clone()

Overrides:

clone in class Object