Package software.amazon.awscdk.services.ec2

Class CfnVolumeProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ec2.CfnVolumeProps.Jsii$Proxy
All Implemented Interfaces:
CfnVolumeProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnVolumeProps
@Stability(Stable) @Internal public static final class CfnVolumeProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnVolumeProps
An implementation for CfnVolumeProps

  • 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(CfnVolumeProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnVolumeProps.Builder.

  • Method Details

    • getAvailabilityZone

      public final String getAvailabilityZone()
      Description copied from interface: CfnVolumeProps
      The ID of the Availability Zone in which to create the volume.

      For example, us-east-1a .

      Specified by:
      getAvailabilityZone in interface CfnVolumeProps

    • getAutoEnableIo

      public final Object getAutoEnableIo()
      Description copied from interface: CfnVolumeProps
      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.

      Specified by:
      getAutoEnableIo in interface CfnVolumeProps

    • getEncrypted

      public final Object getEncrypted()
      Description copied from interface: CfnVolumeProps
      Indicates whether the volume should be encrypted.

      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 .

      Specified by:
      getEncrypted in interface CfnVolumeProps

    • getIops

      public final Number getIops()
      Description copied from interface: CfnVolumeProps
      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

      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.

      Specified by:
      getIops in interface CfnVolumeProps

    • getKmsKeyId

      public final String getKmsKeyId()
      Description copied from interface: CfnVolumeProps
      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.
      Specified by:
      getKmsKeyId in interface CfnVolumeProps

    • getMultiAttachEnabled

      public final Object getMultiAttachEnabled()
      Description copied from interface: CfnVolumeProps
      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.

      Specified by:
      getMultiAttachEnabled in interface CfnVolumeProps

    • getOutpostArn

      public final String getOutpostArn()
      Description copied from interface: CfnVolumeProps
      The Amazon Resource Name (ARN) of the Outpost.
      Specified by:
      getOutpostArn in interface CfnVolumeProps

    • getSize

      public final Number getSize()
      Description copied from interface: CfnVolumeProps
      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
      Specified by:
      getSize in interface CfnVolumeProps

    • getSnapshotId

      public final String getSnapshotId()
      Description copied from interface: CfnVolumeProps
      The snapshot from which to create the volume.

      You must specify either a snapshot ID or a volume size.

      Specified by:
      getSnapshotId in interface CfnVolumeProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnVolumeProps
      The tags to apply to the volume during creation.
      Specified by:
      getTags in interface CfnVolumeProps

    • getThroughput

      public final Number getThroughput()
      Description copied from interface: CfnVolumeProps
      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 CfnVolumeProps

    • getVolumeType

      public final String getVolumeType()
      Description copied from interface: CfnVolumeProps
      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

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

      Default: gp2

      Specified by:
      getVolumeType in interface CfnVolumeProps

    • $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