Class CfnVolumeProps.Jsii$Proxy
- All Implemented Interfaces:
CfnVolumeProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnVolumeProps
CfnVolumeProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.CfnVolumeProps
CfnVolumeProps.Builder, CfnVolumeProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnVolumeProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnVolumeProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal ObjectIndicates whether the volume is auto-enabled for I/O operations.final StringThe ID of the Availability Zone in which to create the volume.final StringThe ID of the Availability Zone in which to create the volume.final ObjectIndicates whether the volume should be encrypted.final NumbergetIops()The number of I/O operations per second (IOPS) to provision for the volume.final StringThe identifier of the AWS KMS key to use for Amazon EBS encryption.final ObjectIndicates whether Amazon EBS Multi-Attach is enabled.final StringThe Amazon Resource Name (ARN) of the Outpost on which to create the volume.final NumbergetSize()The size of the volume, in GiBs.final StringThe snapshot from which to create the volume.final StringThe ID of the source EBS volume to copy.getTags()The tags to apply to the volume during creation.final NumberThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.final NumberSpecifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.final StringThe volume type.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnVolumeProps.Builder.
-
-
Method Details
-
getAutoEnableIo
Description copied from interface:CfnVolumePropsIndicates whether the volume is auto-enabled for I/O operations.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.
Returns union: either
BooleanorIResolvable- Specified by:
getAutoEnableIoin interfaceCfnVolumeProps- See Also:
-
getAvailabilityZone
Description copied from interface:CfnVolumePropsThe ID of the Availability Zone in which to create the volume. For example,us-east-1a.Either
AvailabilityZoneorAvailabilityZoneIdmust be specified, but not both.If you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone as the source volume.
- Specified by:
getAvailabilityZonein interfaceCfnVolumeProps- See Also:
-
getAvailabilityZoneId
Description copied from interface:CfnVolumePropsThe ID of the Availability Zone in which to create the volume. For example,use1-az1.Either
AvailabilityZoneorAvailabilityZoneIdmust be specified, but not both.If you are creating a volume copy, omit this parameter. The volume copy is created in the same Availability Zone as the source volume.
- Specified by:
getAvailabilityZoneIdin interfaceCfnVolumeProps- See Also:
-
getEncrypted
Description copied from interface:CfnVolumePropsIndicates whether the volume should be encrypted.The effect of setting the encryption state to
truedepends on the volume origin (new, from a snapshot, or from an existing volume), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon EBS User Guide .If you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key as the source volume. You can't copy unencrypted volumes.
Returns union: either
BooleanorIResolvable- Specified by:
getEncryptedin interfaceCfnVolumeProps- See Also:
-
getIops
Description copied from interface:CfnVolumePropsThe number of I/O operations per second (IOPS) to provision for the volume.Required for
io1andio2volumes. Optional forgp3volumes. Omit for all other volume types.Valid ranges:
- gp3:
3,000( default )- 80,000IOPS - io1:
100 - 64,000IOPS - io2:
100 - 256,000IOPS
Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
- Specified by:
getIopsin interfaceCfnVolumeProps- See Also:
- gp3:
-
getKmsKeyId
Description copied from interface:CfnVolumePropsThe identifier of the AWS KMS key to use for Amazon EBS encryption.If
KmsKeyIdis specified, the encrypted state must betrue.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:
- Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- Key alias. Specify the alias for the key, prefixed with
alias/. For example, for a key with the aliasmy_cmk, usealias/my_cmk. Or to specify the AWS managed key , usealias/aws/ebs. - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
If you are creating a volume copy, omit this parameter. The volume is automatically encrypted with the same KMS key as the source volume. You can't copy unencrypted volumes.
- Specified by:
getKmsKeyIdin interfaceCfnVolumeProps- See Also:
-
getMultiAttachEnabled
Description copied from interface:CfnVolumePropsIndicates whether Amazon EBS Multi-Attach is enabled.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.
Returns union: either
BooleanorIResolvable- Specified by:
getMultiAttachEnabledin interfaceCfnVolumeProps- See Also:
-
getOutpostArn
Description copied from interface:CfnVolumePropsThe Amazon Resource Name (ARN) of the Outpost on which to create the volume.If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an AWS Region with an instance on an AWS outpost, or the other way around.
- Specified by:
getOutpostArnin interfaceCfnVolumeProps- See Also:
-
getSize
Description copied from interface:CfnVolumePropsThe size of the volume, in GiBs.- Required for new empty volumes.
- Optional for volumes created from snapshots and volume copies. In this case, the size defaults to the size of the snapshot or source volume. You can optionally specify a size that is equal to or larger than the size of the source snapshot or volume.
Supported volume sizes:
- gp2:
1 - 16,384GiB - gp3:
1 - 65,536GiB - io1:
4 - 16,384GiB - io2:
4 - 65,536GiB - st1 and sc1:
125 - 16,384GiB - standard:
1 - 1024GiB
- Specified by:
getSizein interfaceCfnVolumeProps- See Also:
-
getSnapshotId
Description copied from interface:CfnVolumePropsThe snapshot from which to create the volume.Only specify to create a volume from a snapshot. To create a new empty volume, omit this parameter and specify a value for
Sizeinstead. To create a volume copy, omit this parameter and specifySourceVolumeIdinstead.- Specified by:
getSnapshotIdin interfaceCfnVolumeProps- See Also:
-
getSourceVolumeId
Description copied from interface:CfnVolumePropsThe ID of the source EBS volume to copy.When specified, the volume is created as an exact copy of the specified volume. Only specify to create a volume copy. To create a new empty volume or to create a volume from a snapshot, omit this parameter,
- Specified by:
getSourceVolumeIdin interfaceCfnVolumeProps- See Also:
-
getTags
Description copied from interface:CfnVolumePropsThe tags to apply to the volume during creation.- Specified by:
getTagsin interfaceCfnVolumeProps- See Also:
-
getThroughput
Description copied from interface:CfnVolumePropsThe throughput to provision for a volume, with a maximum of 1,000 MiB/s.This parameter is valid only for
gp3volumes. The default value is 125.Valid Range: Minimum value of 125. Maximum value of 1000.
- Specified by:
getThroughputin interfaceCfnVolumeProps- See Also:
-
getVolumeInitializationRate
Description copied from interface:CfnVolumePropsSpecifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume.This is also known as volume initialization . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
- You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
- You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide .
Valid range: 100 - 300 MiB/s
- Specified by:
getVolumeInitializationRatein interfaceCfnVolumeProps- See Also:
-
getVolumeType
Description copied from interface:CfnVolumePropsThe volume type. This parameter can be one of the following values:.- General Purpose SSD:
gp2|gp3 - Provisioned IOPS SSD:
io1|io2 - Throughput Optimized HDD:
st1 - Cold HDD:
sc1 - Magnetic:
standard
Throughput Optimized HDD (
st1) and Cold HDD (sc1) volumes can't be used as boot volumes.For more information, see Amazon EBS volume types in the Amazon EBS User Guide .
Default:
gp2- Specified by:
getVolumeTypein interfaceCfnVolumeProps- See Also:
- General Purpose SSD:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-