* Describes a block device for an EBS volume. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class EbsBlockDevice implements Serializable, Cloneable { /** ** Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide. *
*/ private Boolean deleteOnTermination; /** *
* 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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for gp3
* volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1,
* or standard volumes.
*
* The ID of the snapshot. *
*/ private String snapshotId; /** ** The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a * snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the * snapshot size. *
** The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
* 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.
*
* The throughput that the volume supports, in MiB/s. *
*
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. *
*/ private Integer throughput; /** ** The ARN of the Outpost on which the snapshot is stored. *
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*
* 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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values * differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and
* specify either true for an encrypted volume, or false for an unencrypted volume. If you
* omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must * omit this parameter. If you include this parameter, the request will fail, regardless of the value that you * specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include this
* parameter, but you must specify false. If you specify true, the request will fail. In
* this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify false
* , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you
* omit the parameter.
*
* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide. *
* * @param 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 EC2 User Guide. */ public void setDeleteOnTermination(Boolean deleteOnTermination) { this.deleteOnTermination = 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 EC2 User Guide. *
* * @return Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide. */ public Boolean getDeleteOnTermination() { return this.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 EC2 User Guide. *
* * @param 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 EC2 User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public EbsBlockDevice withDeleteOnTermination(Boolean deleteOnTermination) { setDeleteOnTermination(deleteOnTermination); return this; } /** ** Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide. *
* * @return Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide. */ public Boolean isDeleteOnTermination() { return this.deleteOnTermination; } /** *
* 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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for gp3
* volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1,
* or standard volumes.
*
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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for
* gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2,
* st1, sc1, or standard volumes.
*/
public void setIops(Integer iops) {
this.iops = 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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for gp3
* volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1,
* or standard volumes.
*
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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000
* IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for
* gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2,
* st1, sc1, or standard volumes.
*/
public Integer getIops() {
return this.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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances
* built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for gp3
* volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1,
* or standard volumes.
*
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-64,000 IOPS
*
* For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
*
* This parameter is required for io1 and io2 volumes. The default for
* gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2,
* st1, sc1, or standard volumes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EbsBlockDevice withIops(Integer iops) {
setIops(iops);
return this;
}
/**
*
* The ID of the snapshot. *
* * @param snapshotId * The ID of the snapshot. */ public void setSnapshotId(String snapshotId) { this.snapshotId = snapshotId; } /** ** The ID of the snapshot. *
* * @return The ID of the snapshot. */ public String getSnapshotId() { return this.snapshotId; } /** ** The ID of the snapshot. *
* * @param snapshotId * The ID of the snapshot. * @return Returns a reference to this object so that method calls can be chained together. */ public EbsBlockDevice withSnapshotId(String snapshotId) { setSnapshotId(snapshotId); return this; } /** ** The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a * snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the * snapshot size. *
** The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a * snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the * snapshot size. *
** The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a * snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the * snapshot size. *
** The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The following are the supported volumes sizes for each volume type: *
*
* gp2 and gp3:1-16,384
*
* io1 and io2: 4-16,384
*
* st1 and sc1: 125-16,384
*
* standard: 1-1,024
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
io1 or io2, you must
* specify the IOPS that the volume supports.
* @see VolumeType
*/
public void setVolumeType(String volumeType) {
this.volumeType = volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
io1 or io2
* , you must specify the IOPS that the volume supports.
* @see VolumeType
*/
public String getVolumeType() {
return this.volumeType;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
io1 or io2, you must
* specify the IOPS that the volume supports.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
public EbsBlockDevice withVolumeType(String volumeType) {
setVolumeType(volumeType);
return this;
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
io1 or io2, you must
* specify the IOPS that the volume supports.
* @see VolumeType
*/
public void setVolumeType(VolumeType volumeType) {
withVolumeType(volumeType);
}
/**
*
* The volume type. For more information, see Amazon EBS volume types in the
* Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the
* IOPS that the volume supports.
*
io1 or io2, you must
* specify the IOPS that the volume supports.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VolumeType
*/
public EbsBlockDevice withVolumeType(VolumeType volumeType) {
this.volumeType = volumeType.toString();
return this;
}
/**
* * 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 void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = 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.
*
* This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet,
* and
* RequestSpotInstances.
*/
public String getKmsKeyId() {
return this.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.
*
* This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet,
* and
* RequestSpotInstances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EbsBlockDevice withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* The throughput that the volume supports, in MiB/s. *
*
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. *
* * @param throughput * The throughput that the volume supports, in MiB/s. *
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. */ public void setThroughput(Integer throughput) { this.throughput = throughput; } /** *
* The throughput that the volume supports, in MiB/s. *
*
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. *
* * @return The throughput that the volume supports, in MiB/s. *
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. */ public Integer getThroughput() { return this.throughput; } /** *
* The throughput that the volume supports, in MiB/s. *
*
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. *
* * @param throughput * The throughput that the volume supports, in MiB/s. *
* This parameter is valid only for gp3 volumes.
*
* Valid Range: Minimum value of 125. Maximum value of 1000. * @return Returns a reference to this object so that method calls can be chained together. */ public EbsBlockDevice withThroughput(Integer throughput) { setThroughput(throughput); return this; } /** *
* The ARN of the Outpost on which the snapshot is stored. *
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*/
public void setOutpostArn(String outpostArn) {
this.outpostArn = outpostArn;
}
/**
*
* The ARN of the Outpost on which the snapshot is stored. *
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*/
public String getOutpostArn() {
return this.outpostArn;
}
/**
*
* The ARN of the Outpost on which the snapshot is stored. *
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
*
* This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EbsBlockDevice withOutpostArn(String outpostArn) {
setOutpostArn(outpostArn);
return this;
}
/**
*
* 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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values * differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and
* specify either true for an encrypted volume, or false for an unencrypted volume. If you
* omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must * omit this parameter. If you include this parameter, the request will fail, regardless of the value that you * specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include this
* parameter, but you must specify false. If you specify true, the request will fail. In
* this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify false
* , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you
* omit the parameter.
*
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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this
* parameter, and specify either true for an encrypted volume, or false for an
* unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, regardless of the value * that you specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include
* this parameter, but you must specify false. If you specify true, the request
* will fail. In this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify
* false, the parameter is ignored and the block device mapping is always encrypted. In this
* case, we recommend that you omit the parameter.
*
* 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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values * differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and
* specify either true for an encrypted volume, or false for an unencrypted volume. If you
* omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must * omit this parameter. If you include this parameter, the request will fail, regardless of the value that you * specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include this
* parameter, but you must specify false. If you specify true, the request will fail. In
* this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify false
* , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you
* omit the parameter.
*
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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this
* parameter, and specify either true for an encrypted volume, or false for an
* unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, regardless of the value * that you specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include
* this parameter, but you must specify false. If you specify true, the request
* will fail. In this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify
* false, the parameter is ignored and the block device mapping is always encrypted. In this
* case, we recommend that you omit the parameter.
*
* 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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values * differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and
* specify either true for an encrypted volume, or false for an unencrypted volume. If you
* omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must * omit this parameter. If you include this parameter, the request will fail, regardless of the value that you * specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include this
* parameter, but you must specify false. If you specify true, the request will fail. In
* this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify false
* , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you
* omit the parameter.
*
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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this
* parameter, and specify either true for an encrypted volume, or false for an
* unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, regardless of the value * that you specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include
* this parameter, but you must specify false. If you specify true, the request
* will fail. In this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify
* false, the parameter is ignored and the block device mapping is always encrypted. In this
* case, we recommend that you omit the parameter.
*
* 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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values * differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and
* specify either true for an encrypted volume, or false for an unencrypted volume. If you
* omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must * omit this parameter. If you include this parameter, the request will fail, regardless of the value that you * specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include this
* parameter, but you must specify false. If you specify true, the request will fail. In
* this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify false
* , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you
* omit the parameter.
*
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 EC2 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. *
** This parameter is not returned by DescribeImageAttribute. *
** For CreateImage and RegisterImage, whether you can include this parameter, and the allowed * values differ depending on the type of block device mapping you are creating. *
*
* If you are creating a block device mapping for a new (empty) volume, you can include this
* parameter, and specify either true for an encrypted volume, or false for an
* unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
*
* If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you * must omit this parameter. If you include this parameter, the request will fail, regardless of the value * that you specify. *
*
* If you are creating a block device mapping from an existing unencrypted volume, you can include
* this parameter, but you must specify false. If you specify true, the request
* will fail. In this case, we recommend that you omit the parameter.
*
* If you are creating a block device mapping from an existing encrypted volume, you can include this
* parameter, and specify either true or false. However, if you specify
* false, the parameter is ignored and the block device mapping is always encrypted. In this
* case, we recommend that you omit the parameter.
*