@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.
Constructor and Description |
---|
EbsBlockDevice() |
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 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 customer 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 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 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 customer 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 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 customer 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.
|
public void setDeleteOnTermination(Boolean deleteOnTermination)
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.public Boolean getDeleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.
public EbsBlockDevice withDeleteOnTermination(Boolean deleteOnTermination)
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.
deleteOnTermination
- Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.public Boolean isDeleteOnTermination()
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.
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 io1
IOPS 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.
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 io1
IOPS 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.
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 io1
IOPS 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.
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 io1
IOPS 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.
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 io1
IOPS 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.
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 io1
IOPS 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.
public void setSnapshotId(String snapshotId)
The ID of the snapshot.
snapshotId
- The ID of the snapshot.public String getSnapshotId()
The ID of the snapshot.
public EbsBlockDevice withSnapshotId(String snapshotId)
The ID of the snapshot.
snapshotId
- The ID of the snapshot.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.
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.
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.
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.
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.
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.
public void setVolumeType(String volumeType)
The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
volumeType
- The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
VolumeType
public String getVolumeType()
The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
VolumeType
public EbsBlockDevice withVolumeType(String volumeType)
The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
volumeType
- The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
VolumeType
public void setVolumeType(VolumeType volumeType)
The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
volumeType
- The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
VolumeType
public EbsBlockDevice withVolumeType(VolumeType volumeType)
The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
volumeType
- The volume type. If you set the type to io1
, you must also specify the IOPS that the volume
supports.
Default: gp2
VolumeType
public void setEncrypted(Boolean encrypted)
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
The effect of setting the encryption state to true
depends on the volume origin (new or from a
snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
encrypted
- Indicates whether the encryption state of an EBS volume is changed while being restored from a backing
snapshot. The effect of setting the encryption state to true
depends on the volume origin
(new or from a snapshot), starting encryption state, ownership, and whether encryption by default is
enabled. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
public Boolean getEncrypted()
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
The effect of setting the encryption state to true
depends on the volume origin (new or from a
snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
true
depends on the volume origin
(new or from a snapshot), starting encryption state, ownership, and whether encryption by default is
enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
public EbsBlockDevice withEncrypted(Boolean encrypted)
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
The effect of setting the encryption state to true
depends on the volume origin (new or from a
snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
encrypted
- Indicates whether the encryption state of an EBS volume is changed while being restored from a backing
snapshot. The effect of setting the encryption state to true
depends on the volume origin
(new or from a snapshot), starting encryption state, ownership, and whether encryption by default is
enabled. For more information, see Amazon
EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
public Boolean isEncrypted()
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
The effect of setting the encryption state to true
depends on the volume origin (new or from a
snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
information, see Amazon EBS
Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
true
depends on the volume origin
(new or from a snapshot), starting encryption state, ownership, and whether encryption by default is
enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
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.
public void setKmsKeyId(String kmsKeyId)
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and
RequestSpotInstances.
kmsKeyId
- Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume
is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet,
and
RequestSpotInstances.
public String getKmsKeyId()
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and
RequestSpotInstances.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet,
and
RequestSpotInstances.
public EbsBlockDevice withKmsKeyId(String kmsKeyId)
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet, and
RequestSpotInstances.
kmsKeyId
- Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume
is encrypted.
This parameter is only supported on BlockDeviceMapping
objects called by RunInstances, RequestSpotFleet,
and
RequestSpotInstances.
public String toString()
toString
in class Object
Object.toString()
public EbsBlockDevice clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.