LaunchTemplateEbsBlockDeviceRequest (AWS SDK for Java

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

Constructors
Constructor and Description
`LaunchTemplateEbsBlockDeviceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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).
`String`	`getKmsKeyId()` The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
`String`	`getSnapshotId()` The ID of the snapshot.
`Integer`	`getThroughput()` The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
`Integer`	`getVolumeSize()` The size of the volume, in GiBs.
`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).
`void`	`setKmsKeyId(String kmsKeyId)` The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
`void`	`setSnapshotId(String snapshotId)` The ID of the snapshot.
`void`	`setThroughput(Integer throughput)` The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
`void`	`setVolumeSize(Integer volumeSize)` The size of the volume, in GiBs.
`void`	`setVolumeType(String volumeType)` The volume type.
`String`	`toString()` Returns a string representation of this object.
`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).
`LaunchTemplateEbsBlockDeviceRequest`	`withKmsKeyId(String kmsKeyId)` The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
`LaunchTemplateEbsBlockDeviceRequest`	`withSnapshotId(String snapshotId)` The ID of the snapshot.
`LaunchTemplateEbsBlockDeviceRequest`	`withThroughput(Integer throughput)` The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
`LaunchTemplateEbsBlockDeviceRequest`	`withVolumeSize(Integer volumeSize)` The size of the volume, in GiBs.
`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). For gp3, io1, and io2 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
    - io2: 100 - 256,000 IOPS
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
    Parameters:
    iops - The number of I/O operations per second (IOPS). For gp3, io1, and io2 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
    
    io2: 100 - 256,000 IOPS
    
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
  - getIops
```
public Integer getIops()
```
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 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
    - io2: 100 - 256,000 IOPS
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
    Returns:
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 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
    
    io2: 100 - 256,000 IOPS
    
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
  - withIops
```
public LaunchTemplateEbsBlockDeviceRequest withIops(Integer iops)
```
    The number of I/O operations per second (IOPS). For gp3, io1, and io2 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
    - io2: 100 - 256,000 IOPS
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
    Parameters:
    iops - The number of I/O operations per second (IOPS). For gp3, io1, and io2 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
    
    io2: 100 - 256,000 IOPS
    
    For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
    
    This parameter is supported for io1, io2, and gp3 volumes only.
    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 symmetric Key Management Service (KMS) CMK used for encryption.
    
    Parameters:
    
    kmsKeyId - The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
    
    Returns:
    
    The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
  - withKmsKeyId
```
public LaunchTemplateEbsBlockDeviceRequest withKmsKeyId(String kmsKeyId)
```
    The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.
    
    Parameters:
    
    kmsKeyId - The ARN of the symmetric Key Management Service (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 GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    - gp2 and gp3: 1 - 16,384 GiB
    - io1: 4 - 16,384 GiB
    - io2: 4 - 65,536 GiB
    - st1 and sc1: 125 - 16,384 GiB
    - standard: 1 - 1024 GiB
    Parameters:
    volumeSize - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    
    gp2 and gp3: 1 - 16,384 GiB
    
    io1: 4 - 16,384 GiB
    
    io2: 4 - 65,536 GiB
    
    st1 and sc1: 125 - 16,384 GiB
    
    standard: 1 - 1024 GiB
  - getVolumeSize
```
public Integer getVolumeSize()
```
    The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    - gp2 and gp3: 1 - 16,384 GiB
    - io1: 4 - 16,384 GiB
    - io2: 4 - 65,536 GiB
    - st1 and sc1: 125 - 16,384 GiB
    - standard: 1 - 1024 GiB
    Returns:
    The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    
    gp2 and gp3: 1 - 16,384 GiB
    
    io1: 4 - 16,384 GiB
    
    io2: 4 - 65,536 GiB
    
    st1 and sc1: 125 - 16,384 GiB
    
    standard: 1 - 1024 GiB
  - withVolumeSize
```
public LaunchTemplateEbsBlockDeviceRequest withVolumeSize(Integer volumeSize)
```
    The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    - gp2 and gp3: 1 - 16,384 GiB
    - io1: 4 - 16,384 GiB
    - io2: 4 - 65,536 GiB
    - st1 and sc1: 125 - 16,384 GiB
    - standard: 1 - 1024 GiB
    Parameters:
    volumeSize - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
    
    gp2 and gp3: 1 - 16,384 GiB
    
    io1: 4 - 16,384 GiB
    
    io2: 4 - 65,536 GiB
    
    st1 and sc1: 125 - 16,384 GiB
    
    standard: 1 - 1024 GiB
    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.
    
    Parameters:
    
    volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    See Also:
    
    VolumeType
  - getVolumeType
```
public String getVolumeType()
```
    The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    Returns:
    
    The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    See Also:
    
    VolumeType
  - withVolumeType
```
public LaunchTemplateEbsBlockDeviceRequest withVolumeType(String volumeType)
```
    The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    Parameters:
    
    volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    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. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    Parameters:
    
    volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeType
  - setThroughput
```
public void setThroughput(Integer throughput)
```
    The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
    
    Parameters:
    
    throughput - The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
  - getThroughput
```
public Integer getThroughput()
```
    The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
    
    Returns:
    
    The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
  - withThroughput
```
public LaunchTemplateEbsBlockDeviceRequest withThroughput(Integer throughput)
```
    The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
    
    Parameters:
    
    throughput - The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
    
    Valid Range: Minimum value of 125. Maximum value of 1000.
    
    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 LaunchTemplateEbsBlockDeviceRequest clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class LaunchTemplateEbsBlockDeviceRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LaunchTemplateEbsBlockDeviceRequest

Method Detail

setEncrypted

getEncrypted

withEncrypted

isEncrypted

setDeleteOnTermination

getDeleteOnTermination

withDeleteOnTermination

isDeleteOnTermination

setIops

getIops

withIops

setKmsKeyId

getKmsKeyId

withKmsKeyId

setSnapshotId

getSnapshotId

withSnapshotId

setVolumeSize

getVolumeSize

withVolumeSize

setVolumeType

getVolumeType

withVolumeType

withVolumeType

setThroughput

getThroughput

withThroughput

toString

equals

hashCode

clone