com.amazonaws.services.ec2.model

Class LaunchTemplateEbsBlockDeviceRequest

java.lang.Object

com.amazonaws.services.ec2.model.LaunchTemplateEbsBlockDeviceRequest

All Implemented Interfaces:

Serializable, Cloneable

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

The parameters for a block device for an EBS volume.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LaunchTemplateEbsBlockDeviceRequest()

Method Summary

Modifier and Type	Method and Description
LaunchTemplateEbsBlockDeviceRequest	clone()
boolean	equals(Object obj)
Boolean	getDeleteOnTermination() Indicates whether the EBS volume is deleted on instance termination.
Boolean	getEncrypted() Indicates whether the EBS volume is encrypted.
Integer	getIops() The number of I/O operations per second (IOPS) that the volume supports.
String	getKmsKeyId() The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
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 EBS volume is encrypted.
void	setDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
void	setEncrypted(Boolean encrypted) Indicates whether the EBS volume is encrypted.
void	setIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
void	setKmsKeyId(String kmsKeyId) The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LaunchTemplateEbsBlockDeviceRequest	withDeleteOnTermination(Boolean deleteOnTermination) Indicates whether the EBS volume is deleted on instance termination.
LaunchTemplateEbsBlockDeviceRequest	withEncrypted(Boolean encrypted) Indicates whether the EBS volume is encrypted.
LaunchTemplateEbsBlockDeviceRequest	withIops(Integer iops) The number of I/O operations per second (IOPS) that the volume supports.
LaunchTemplateEbsBlockDeviceRequest	withKmsKeyId(String kmsKeyId) The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
LaunchTemplateEbsBlockDeviceRequest	withSnapshotId(String snapshotId) The ID of the snapshot.
LaunchTemplateEbsBlockDeviceRequest	withVolumeSize(Integer volumeSize) The size of the volume, in GiB.
LaunchTemplateEbsBlockDeviceRequest	withVolumeType(String volumeType) The volume type.
LaunchTemplateEbsBlockDeviceRequest	withVolumeType(VolumeType volumeType) The volume type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LaunchTemplateEbsBlockDeviceRequest

public LaunchTemplateEbsBlockDeviceRequest()

Method Detail

setEncrypted

public void setEncrypted(Boolean encrypted)

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Parameters:

encrypted - Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

getEncrypted

public Boolean getEncrypted()

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Returns:

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

withEncrypted

public LaunchTemplateEbsBlockDeviceRequest withEncrypted(Boolean encrypted)

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Parameters:

encrypted - Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

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 volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Returns:

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

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 LaunchTemplateEbsBlockDeviceRequest 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, 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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, 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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, 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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, 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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 LaunchTemplateEbsBlockDeviceRequest 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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, 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 about General Purpose SSD baseline performance, I/O credits, and bursting, 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.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

Parameters:

kmsKeyId - The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

getKmsKeyId

public String getKmsKeyId()

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

Returns:

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

withKmsKeyId

public LaunchTemplateEbsBlockDeviceRequest withKmsKeyId(String kmsKeyId)

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

Parameters:

kmsKeyId - The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

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 LaunchTemplateEbsBlockDeviceRequest 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.

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.

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.

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.

withVolumeSize

public LaunchTemplateEbsBlockDeviceRequest 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.

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.

Returns:

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

setVolumeType

public void setVolumeType(String volumeType)

The volume type.

Parameters:

volumeType - The volume type.

See Also:

VolumeType

getVolumeType

public String getVolumeType()

The volume type.

Returns:

The volume type.

See Also:

VolumeType

withVolumeType

public LaunchTemplateEbsBlockDeviceRequest withVolumeType(String volumeType)

The volume type.

Parameters:

volumeType - The volume type.

Returns:

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

See Also:

VolumeType

withVolumeType

public LaunchTemplateEbsBlockDeviceRequest withVolumeType(VolumeType volumeType)

The volume type.

Parameters:

volumeType - The volume type.

Returns:

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

See Also:

VolumeType

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:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public LaunchTemplateEbsBlockDeviceRequest clone()

Overrides:

clone in class Object