com.amazonaws.services.ec2.model.EbsBlockDevice Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* 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.
*
*/
private Integer iops;
/**
*
* 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
*
*
*
*/
private Integer volumeSize;
/**
*
* 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.
*
*/
private String volumeType;
/**
*
* 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.
*
*/
private String kmsKeyId;
/**
*
* 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.
*
*/
private String outpostArn;
/**
*
* 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.
*
*
*
*/
private Boolean encrypted;
/**
*
* 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.
*
*
* @param 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.
*/
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.
*
*
* @return 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.
*/
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.
*
*
* @param 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.
* @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
*
*
*
*
* @param volumeSize
* 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
*
*
*/
public void setVolumeSize(Integer volumeSize) {
this.volumeSize = volumeSize;
}
/**
*
* 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
*
*
*
*
* @return 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
*
*
*/
public Integer getVolumeSize() {
return this.volumeSize;
}
/**
*
* 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
*
*
*
*
* @param volumeSize
* 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EbsBlockDevice withVolumeSize(Integer volumeSize) {
setVolumeSize(volumeSize);
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.
*
*
* @param 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.
* @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.
*
*
* @return 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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 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.
*
*
* @return 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() {
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.
*
*
* @param 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.
* @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.
*
*
* @param outpostArn
* The ARN of the Outpost on which the snapshot is stored.
*
* 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.
*
*
* @return The ARN of the Outpost on which the snapshot is stored.
*
* 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.
*
*
* @param outpostArn
* The ARN of the Outpost on which the snapshot is stored.
*
* 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.
*
*
*
*
* @param 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 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.
*
*
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = 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 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.
*
*
*
*
* @return 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.
*
*
*/
public Boolean getEncrypted() {
return this.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 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.
*
*
*
*
* @param 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 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EbsBlockDevice withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
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.
*
*
*
*
* @return 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.
*
*
*/
public Boolean isEncrypted() {
return this.encrypted;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDeleteOnTermination() != null)
sb.append("DeleteOnTermination: ").append(getDeleteOnTermination()).append(",");
if (getIops() != null)
sb.append("Iops: ").append(getIops()).append(",");
if (getSnapshotId() != null)
sb.append("SnapshotId: ").append(getSnapshotId()).append(",");
if (getVolumeSize() != null)
sb.append("VolumeSize: ").append(getVolumeSize()).append(",");
if (getVolumeType() != null)
sb.append("VolumeType: ").append(getVolumeType()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getThroughput() != null)
sb.append("Throughput: ").append(getThroughput()).append(",");
if (getOutpostArn() != null)
sb.append("OutpostArn: ").append(getOutpostArn()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EbsBlockDevice == false)
return false;
EbsBlockDevice other = (EbsBlockDevice) obj;
if (other.getDeleteOnTermination() == null ^ this.getDeleteOnTermination() == null)
return false;
if (other.getDeleteOnTermination() != null && other.getDeleteOnTermination().equals(this.getDeleteOnTermination()) == false)
return false;
if (other.getIops() == null ^ this.getIops() == null)
return false;
if (other.getIops() != null && other.getIops().equals(this.getIops()) == false)
return false;
if (other.getSnapshotId() == null ^ this.getSnapshotId() == null)
return false;
if (other.getSnapshotId() != null && other.getSnapshotId().equals(this.getSnapshotId()) == false)
return false;
if (other.getVolumeSize() == null ^ this.getVolumeSize() == null)
return false;
if (other.getVolumeSize() != null && other.getVolumeSize().equals(this.getVolumeSize()) == false)
return false;
if (other.getVolumeType() == null ^ this.getVolumeType() == null)
return false;
if (other.getVolumeType() != null && other.getVolumeType().equals(this.getVolumeType()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getThroughput() == null ^ this.getThroughput() == null)
return false;
if (other.getThroughput() != null && other.getThroughput().equals(this.getThroughput()) == false)
return false;
if (other.getOutpostArn() == null ^ this.getOutpostArn() == null)
return false;
if (other.getOutpostArn() != null && other.getOutpostArn().equals(this.getOutpostArn()) == false)
return false;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDeleteOnTermination() == null) ? 0 : getDeleteOnTermination().hashCode());
hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode());
hashCode = prime * hashCode + ((getSnapshotId() == null) ? 0 : getSnapshotId().hashCode());
hashCode = prime * hashCode + ((getVolumeSize() == null) ? 0 : getVolumeSize().hashCode());
hashCode = prime * hashCode + ((getVolumeType() == null) ? 0 : getVolumeType().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getThroughput() == null) ? 0 : getThroughput().hashCode());
hashCode = prime * hashCode + ((getOutpostArn() == null) ? 0 : getOutpostArn().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
return hashCode;
}
@Override
public EbsBlockDevice clone() {
try {
return (EbsBlockDevice) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}