/* * 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; /** *

* The parameters for a block device for an EBS volume. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class LaunchTemplateEbsBlockDeviceRequest implements Serializable, Cloneable { /** *

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

*/ private Boolean encrypted; /** *

* Indicates whether the EBS volume is deleted on instance termination. *

*/ 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 supported for io1, io2, and gp3 volumes only. This * parameter is not supported for gp2, st1, sc1, or standard * volumes. *

*/ private Integer iops; /** *

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

*/ private String kmsKeyId; /** *

* 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. 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 Elastic Compute Cloud User Guide. *

*/ private String volumeType; /** *

* The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. *

* Valid Range: Minimum value of 125. Maximum value of 1000. *

*/ private Integer throughput; /** *

* * @param encrypted * Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that * support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an * encryption value. */ public void setEncrypted(Boolean encrypted) { this.encrypted = encrypted; } /** *

* * @return Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that * support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an * encryption value. */ public Boolean getEncrypted() { return this.encrypted; } /** *

* * @param encrypted * Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that * support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an * encryption value. * @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateEbsBlockDeviceRequest withEncrypted(Boolean encrypted) { setEncrypted(encrypted); return this; } /** *

* Indicates whether the EBS volume is deleted on instance termination. *

* * @param deleteOnTermination * Indicates whether the EBS volume is deleted on instance termination. */ public void setDeleteOnTermination(Boolean deleteOnTermination) { this.deleteOnTermination = deleteOnTermination; } /** *

* Indicates whether the EBS volume is deleted on instance termination. *

* * @return Indicates whether the EBS volume is deleted on instance termination. */ public Boolean getDeleteOnTermination() { return this.deleteOnTermination; } /** *

* Indicates whether the EBS volume is deleted on instance termination. *

* * @param deleteOnTermination * Indicates whether the EBS volume is deleted on instance termination. * @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateEbsBlockDeviceRequest withDeleteOnTermination(Boolean deleteOnTermination) { setDeleteOnTermination(deleteOnTermination); return this; } /** *

* Indicates whether the EBS volume is deleted on instance termination. *

* * @return Indicates whether the EBS volume is deleted on instance termination. */ public Boolean isDeleteOnTermination() { return this.deleteOnTermination; } /** *

* 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 supported for io1, io2, and gp3 volumes only. 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 supported for io1, io2, and gp3 volumes only. * This parameter is not supported for gp2, st1, sc1, or * standard volumes. */ public void setIops(Integer iops) { this.iops = iops; } /** *

* 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 supported for io1, io2, and gp3 volumes only. 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 supported for io1, io2, and gp3 volumes only. * This parameter is not supported for gp2, st1, sc1, or * standard volumes. */ public Integer getIops() { return this.iops; } /** *

* 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 supported for io1, io2, and gp3 volumes only. This * parameter is not supported for gp2, st1, sc1, or standard * volumes. *

* 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 supported for io1, io2, and gp3 volumes only. * 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 LaunchTemplateEbsBlockDeviceRequest withIops(Integer iops) { setIops(iops); return this; } /** *

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

* * @param kmsKeyId * The ARN of the symmetric Key Management Service (KMS) CMK used for encryption. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** *

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

* * @return The ARN of the symmetric Key Management Service (KMS) CMK used for encryption. */ public String getKmsKeyId() { return this.kmsKeyId; } /** *

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

* * @param kmsKeyId * The ARN of the symmetric Key Management Service (KMS) CMK used for encryption. * @return Returns a reference to this object so that method calls can be chained together. */ public LaunchTemplateEbsBlockDeviceRequest withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); 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 LaunchTemplateEbsBlockDeviceRequest 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. 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. 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. 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 *
*

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

*
* 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 Elastic Compute Cloud User Guide. *

Amazon EBS volume types

Amazon Elastic Compute Cloud User Guide

* The volume type. For more information, see Amazon EBS volume types in the * Amazon Elastic Compute Cloud User Guide. *

Amazon EBS volume * types

Amazon Elastic Compute Cloud User Guide

* The volume type. For more information, see Amazon EBS volume types in the * Amazon Elastic Compute Cloud User Guide. *

Amazon EBS volume types

Amazon Elastic Compute Cloud User Guide

* The volume type. For more information, see Amazon EBS volume types in the * Amazon Elastic Compute Cloud User Guide. *

Amazon EBS volume types

Amazon Elastic Compute Cloud User Guide

* The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. *

* Valid Range: Minimum value of 125. Maximum value of 1000. *

gp3

* Valid Range: Minimum value of 125. Maximum value of 1000. */ public void setThroughput(Integer throughput) { this.throughput = throughput; } /** *

* The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. *

* Valid Range: Minimum value of 125. Maximum value of 1000. *

gp3

* Valid Range: Minimum value of 125. Maximum value of 1000. */ public Integer getThroughput() { return this.throughput; } /** *

* The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. *

* Valid Range: Minimum value of 125. Maximum value of 1000. *

gp3

* 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 LaunchTemplateEbsBlockDeviceRequest withThroughput(Integer throughput) { setThroughput(throughput); return this; } /** * 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 (getEncrypted() != null) sb.append("Encrypted: ").append(getEncrypted()).append(","); if (getDeleteOnTermination() != null) sb.append("DeleteOnTermination: ").append(getDeleteOnTermination()).append(","); if (getIops() != null) sb.append("Iops: ").append(getIops()).append(","); if (getKmsKeyId() != null) sb.append("KmsKeyId: ").append(getKmsKeyId()).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 (getThroughput() != null) sb.append("Throughput: ").append(getThroughput()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof LaunchTemplateEbsBlockDeviceRequest == false) return false; LaunchTemplateEbsBlockDeviceRequest other = (LaunchTemplateEbsBlockDeviceRequest) obj; if (other.getEncrypted() == null ^ this.getEncrypted() == null) return false; if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false) return false; 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.getKmsKeyId() == null ^ this.getKmsKeyId() == null) return false; if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == 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.getThroughput() == null ^ this.getThroughput() == null) return false; if (other.getThroughput() != null && other.getThroughput().equals(this.getThroughput()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode()); hashCode = prime * hashCode + ((getDeleteOnTermination() == null) ? 0 : getDeleteOnTermination().hashCode()); hashCode = prime * hashCode + ((getIops() == null) ? 0 : getIops().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().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 + ((getThroughput() == null) ? 0 : getThroughput().hashCode()); return hashCode; } @Override public LaunchTemplateEbsBlockDeviceRequest clone() { try { return (LaunchTemplateEbsBlockDeviceRequest) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }