Package software.amazon.awscdk.mixins.preview.services.ec2.mixins

Class CfnVolumeMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.services.ec2.mixins.CfnVolumeMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnVolumeMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnVolumeMixinProps

@Stability(Stable)
@Internal
public static final class CfnVolumeMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnVolumeMixinProps

An implementation for CfnVolumeMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.ec2.mixins.CfnVolumeMixinProps

CfnVolumeMixinProps.Builder, CfnVolumeMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnVolumeMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnVolumeMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAutoEnableIo()	Indicates whether the volume is auto-enabled for I/O operations.
final String	getAvailabilityZone()	The ID of the Availability Zone in which to create the volume.
final String	getAvailabilityZoneId()	The ID of the Availability Zone in which to create the volume.
final Object	getEncrypted()	Indicates whether the volume should be encrypted.
final Number	getIops()	The number of I/O operations per second (IOPS) to provision for the volume.
final String	getKmsKeyId()	The identifier of the AWS KMS key to use for Amazon EBS encryption.
final Object	getMultiAttachEnabled()	Indicates whether Amazon EBS Multi-Attach is enabled.
final String	getOutpostArn()	The Amazon Resource Name (ARN) of the Outpost on which to create the volume.
final Number	getSize()	The size of the volume, in GiBs.
final String	getSnapshotId()	The snapshot from which to create the volume.
final String	getSourceVolumeId()	The ID of the source EBS volume to copy.
final List<CfnTag>	getTags()	The tags to apply to the volume during creation.
final Number	getThroughput()	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
final Number	getVolumeInitializationRate()	Specifies 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 String	getVolumeType()	The volume type.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(CfnVolumeMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnVolumeMixinProps.Builder.

Method Details

getAutoEnableIo

public final Object getAutoEnableIo()

Description copied from interface: CfnVolumeMixinProps

Indicates 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 Boolean or IResolvable

Specified by:

getAutoEnableIo in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio

getAvailabilityZone

public final String getAvailabilityZone()

Description copied from interface: CfnVolumeMixinProps

The ID of the Availability Zone in which to create the volume. For example, us-east-1a .

Either AvailabilityZone or AvailabilityZoneId must 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:

getAvailabilityZone in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone

getAvailabilityZoneId

public final String getAvailabilityZoneId()

Description copied from interface: CfnVolumeMixinProps

The ID of the Availability Zone in which to create the volume. For example, use1-az1 .

Either AvailabilityZone or AvailabilityZoneId must 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:

getAvailabilityZoneId in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid

getEncrypted

public final Object getEncrypted()

Description copied from interface: CfnVolumeMixinProps

Indicates whether the volume should be encrypted.

The effect of setting the encryption state to true depends 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 Boolean or IResolvable

Specified by:

getEncrypted in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted

getIops

public final Number getIops()

Description copied from interface: CfnVolumeMixinProps

The number of I/O operations per second (IOPS) to provision for the volume.

Required for io1 and io2 volumes. Optional for gp3 volumes. Omit for all other volume types.

Valid ranges:

• gp3: 3,000 ( default ) - 80,000 IOPS
• io1: 100 - 64,000 IOPS
• io2: 100 - 256,000 IOPS

Instances built on the Nitro System can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.

Specified by:

getIops in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnVolumeMixinProps

The identifier of the AWS KMS key to use for Amazon EBS encryption.

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:

• 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 alias my_cmk , use alias/my_cmk . Or to specify the AWS managed key , use alias/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:

getKmsKeyId in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid

getMultiAttachEnabled

public final Object getMultiAttachEnabled()

Description copied from interface: CfnVolumeMixinProps

Indicates 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 Boolean or IResolvable

Specified by:

getMultiAttachEnabled in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled

getOutpostArn

public final String getOutpostArn()

Description copied from interface: CfnVolumeMixinProps

The 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:

getOutpostArn in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn

getSize

public final Number getSize()

Description copied from interface: CfnVolumeMixinProps

The 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,384 GiB
• gp3: 1 - 65,536 GiB
• io1: 4 - 16,384 GiB
• io2: 4 - 65,536 GiB
• st1 and sc1: 125 - 16,384 GiB
• standard: 1 - 1024 GiB

Specified by:

getSize in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size

getSnapshotId

public final String getSnapshotId()

Description copied from interface: CfnVolumeMixinProps

The 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 Size instead. To create a volume copy, omit this parameter and specify SourceVolumeId instead.

Specified by:

getSnapshotId in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid

getSourceVolumeId

public final String getSourceVolumeId()

Description copied from interface: CfnVolumeMixinProps

The 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:

getSourceVolumeId in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnVolumeMixinProps

The tags to apply to the volume during creation.

Specified by:

getTags in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags

getThroughput

public final Number getThroughput()

Description copied from interface: CfnVolumeMixinProps

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

This parameter is valid only for gp3 volumes. The default value is 125.

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

Specified by:

getThroughput in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput

getVolumeInitializationRate

public final Number getVolumeInitializationRate()

Description copied from interface: CfnVolumeMixinProps

Specifies 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:

getVolumeInitializationRate in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate

getVolumeType

public final String getVolumeType()

Description copied from interface: CfnVolumeMixinProps

The 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:

getVolumeType in interface CfnVolumeMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object