@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:38.399Z") @Stability(value=Stable) public interface CfnVolumeProps extends software.amazon.jsii.JsiiSerializable
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;
CfnVolumeProps cfnVolumeProps = CfnVolumeProps.builder()
.availabilityZone("availabilityZone")
// the properties below are optional
.autoEnableIo(false)
.encrypted(false)
.iops(123)
.kmsKeyId("kmsKeyId")
.multiAttachEnabled(false)
.outpostArn("outpostArn")
.size(123)
.snapshotId("snapshotId")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.throughput(123)
.volumeType("volumeType")
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnVolumeProps.Builder
A builder for
CfnVolumeProps |
static class |
CfnVolumeProps.Jsii$Proxy
An implementation for
CfnVolumeProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnVolumeProps.Builder |
builder() |
default Object |
getAutoEnableIo()
Indicates whether the volume is auto-enabled for I/O operations.
|
String |
getAvailabilityZone()
The Availability Zone in which to create the volume.
|
default Object |
getEncrypted()
Indicates whether the volume should be encrypted.
|
default Number |
getIops()
The number of I/O operations per second (IOPS).
|
default String |
getKmsKeyId()
The identifier of the AWS KMS key to use for Amazon EBS encryption.
|
default Object |
getMultiAttachEnabled()
Indicates whether Amazon EBS Multi-Attach is enabled.
|
default String |
getOutpostArn()
The Amazon Resource Name (ARN) of the Outpost.
|
default Number |
getSize()
The size of the volume, in GiBs.
|
default String |
getSnapshotId()
The snapshot from which to create the volume.
|
default List<CfnTag> |
getTags()
The tags to apply to the volume during creation.
|
default Number |
getThroughput()
The throughput that the volume supports, in MiB/s.
|
default String |
getVolumeType()
The volume type.
|
@Stability(value=Stable) @NotNull String getAvailabilityZone()
@Stability(value=Stable) @Nullable default Object getAutoEnableIo()
By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
@Stability(value=Stable) @Nullable default Object getEncrypted()
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 Encryption by default in the Amazon Elastic Compute Cloud User Guide .
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .
@Stability(value=Stable) @Nullable default Number getIops()
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 IOPSio1 : 100-64,000 IOPSio2 : 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System . Other instance families support 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.
@Stability(value=Stable) @Nullable default String getKmsKeyId()
If KmsKeyId is specified, the encrypted state must be true .
If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
Alternatively, if you want to specify a different key, you can specify one of the following:
alias/ . For example, for a key with the alias my_cmk , use alias/my_cmk . Or to specify the AWS managed key , use alias/aws/ebs .@Stability(value=Stable) @Nullable default Object getMultiAttachEnabled()
AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
@Stability(value=Stable) @Nullable default String getOutpostArn()
@Stability(value=Stable) @Nullable default Number getSize()
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,384io1 and io2 : 4-16,384st1 and sc1 : 125-16,384standard : 1-1,024@Stability(value=Stable) @Nullable default String getSnapshotId()
You must specify either a snapshot ID or a volume size.
@Stability(value=Stable) @Nullable default List<CfnTag> getTags()
@Stability(value=Stable) @Nullable default Number getThroughput()
@Stability(value=Stable) @Nullable default String getVolumeType()
gp2 | gp3io1 | io2st1sc1standardFor more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .
Default: gp2
@Stability(value=Stable) static CfnVolumeProps.Builder builder()
CfnVolumeProps.Builder of CfnVolumePropsCopyright © 2022. All rights reserved.