com.amazonaws.services.ec2.model

Class EbsBlockDevice

java.lang.Object

com.amazonaws.services.ec2.model.EbsBlockDevice

All Implemented Interfaces:

Serializable, Cloneable

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

Describes a block device for an EBS volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EbsBlockDevice()

Method Summary

Modifier and Type	Method and Description
EbsBlockDevice	clone()
boolean	equals(Object obj)
Boolean	getDeleteOnTermination() Indicates whether the EBS volume is deleted on instance termination.
Boolean	getEncrypted() Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot.
Integer	getIops() The number of I/O operations per second (IOPS) that the volume supports.
String	getKmsKeyId() Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.
String	getSnapshotId() The ID of the snapshot.
Integer	getVolumeSize() The size of the volume, in GiB.
String	getVolumeType() The volume type.
int	hashCode()
Boolean	isDeleteOnTermination() Indicates whether the EBS volume is deleted on instance termination.
Boolean	isEncrypted() Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot.
void	setDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
void	setEncrypted(Boolean encrypted) Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot.
void	setIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
void	setKmsKeyId(String kmsKeyId) Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.
void	setSnapshotId(String snapshotId) The ID of the snapshot.
void	setVolumeSize(Integer volumeSize) The size of the volume, in GiB.
void	setVolumeType(String volumeType) The volume type.
void	setVolumeType(VolumeType volumeType) The volume type.
String	toString() Returns a string representation of this object.
EbsBlockDevice	withDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
EbsBlockDevice	withEncrypted(Boolean encrypted) Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot.
EbsBlockDevice	withIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
EbsBlockDevice	withKmsKeyId(String kmsKeyId) Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.
EbsBlockDevice	withSnapshotId(String snapshotId) The ID of the snapshot.
EbsBlockDevice	withVolumeSize(Integer volumeSize) The size of the volume, in GiB.
EbsBlockDevice	withVolumeType(String volumeType) The volume type.
EbsBlockDevice	withVolumeType(VolumeType volumeType) The volume type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EbsBlockDevice

public EbsBlockDevice()

Method Detail

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.

setIops

public void setIops(Integer iops)

The number of I/O operations per second (IOPS) that the volume supports. For 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS 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.

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.

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.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

Parameters:

volumeSize - The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

getVolumeSize

public Integer getVolumeSize()

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

Returns:

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

withVolumeSize

public EbsBlockDevice withVolumeSize(Integer volumeSize)

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

Parameters:

volumeSize - The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

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.

Returns:

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

setVolumeType

public void setVolumeType(String volumeType)

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Parameters:

volumeType - The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

See Also:

VolumeType

getVolumeType

public String getVolumeType()

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Returns:

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

See Also:

VolumeType

withVolumeType

public EbsBlockDevice withVolumeType(String volumeType)

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Parameters:

volumeType - The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Returns:

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

See Also:

VolumeType

setVolumeType

public void setVolumeType(VolumeType volumeType)

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Parameters:

volumeType - The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

See Also:

VolumeType

withVolumeType

public EbsBlockDevice withVolumeType(VolumeType volumeType)

The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Parameters:

volumeType - The volume type. If you set the type to io1, you must also set the Iops property.

Default: standard

Returns:

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

See Also:

VolumeType

setEncrypted

public void setEncrypted(Boolean encrypted)

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Parameters:

encrypted - Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

getEncrypted

public Boolean getEncrypted()

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Returns:

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

withEncrypted

public EbsBlockDevice withEncrypted(Boolean encrypted)

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Parameters:

encrypted - Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Returns:

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

isEncrypted

public Boolean isEncrypted()

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

Returns:

Indicates whether the encryption state of an EBS volume is to be changed while being restored from a backing snapshot. The default effect of setting this parameter to true or leaving it unset depends on the origin, starting encryption state, and ownership of the volume. Each default case can be overridden by specifying a customer master key (CMK) as argument to the KmsKeyId parameter in addition to setting Encrypted = true. For a complete list of possible encryption cases, see Amazon EBS Encryption.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Parameters:

kmsKeyId - Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

getKmsKeyId

public String getKmsKeyId()

Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Returns:

Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

withKmsKeyId

public EbsBlockDevice withKmsKeyId(String kmsKeyId)

Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Parameters:

kmsKeyId - Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

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 EbsBlockDevice clone()

Overrides:

clone in class Object