Package software.amazon.awscdk.services.ec2

Class CfnVolume.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.CfnVolume.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnVolume>
Enclosing class:
CfnVolume
@Stability(Stable) public static final class CfnVolume.Builder extends Object implements software.amazon.jsii.Builder<CfnVolume>
A fluent builder for CfnVolume.

  • Method Details

    • create

      @Stability(Stable) public static CfnVolume.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      Returns:
      a new instance of CfnVolume.Builder.

    • autoEnableIo

      @Stability(Stable) public CfnVolume.Builder autoEnableIo(Boolean autoEnableIo)
      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.

      Parameters:
      autoEnableIo - Indicates whether the volume is auto-enabled for I/O operations. This parameter is required.
      Returns:
      this
      See Also:

    • autoEnableIo

      @Stability(Stable) public CfnVolume.Builder autoEnableIo(IResolvable autoEnableIo)
      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.

      Parameters:
      autoEnableIo - Indicates whether the volume is auto-enabled for I/O operations. This parameter is required.
      Returns:
      this
      See Also:

    • availabilityZone

      @Stability(Stable) public CfnVolume.Builder availabilityZone(String availabilityZone)
      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.

      Parameters:
      availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a . This parameter is required.
      Returns:
      this
      See Also:

    • availabilityZoneId

      @Stability(Stable) public CfnVolume.Builder availabilityZoneId(String availabilityZoneId)
      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.

      Parameters:
      availabilityZoneId - The ID of the Availability Zone in which to create the volume. For example, use1-az1 . This parameter is required.
      Returns:
      this
      See Also:

    • encrypted

      @Stability(Stable) public CfnVolume.Builder encrypted(Boolean encrypted)
      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.

      Parameters:
      encrypted - Indicates whether the volume should be encrypted. This parameter is required.
      Returns:
      this
      See Also:

    • encrypted

      @Stability(Stable) public CfnVolume.Builder encrypted(IResolvable encrypted)
      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.

      Parameters:
      encrypted - Indicates whether the volume should be encrypted. This parameter is required.
      Returns:
      this
      See Also:

    • iops

      @Stability(Stable) public CfnVolume.Builder iops(Number iops)
      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.

      Parameters:
      iops - The number of I/O operations per second (IOPS) to provision for the volume. This parameter is required.
      Returns:
      this
      See Also:

    • kmsKeyId

      @Stability(Stable) public CfnVolume.Builder kmsKeyId(String kmsKeyId)
      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.

      Parameters:
      kmsKeyId - The identifier of the AWS KMS key to use for Amazon EBS encryption. This parameter is required.
      Returns:
      this
      See Also:

    • multiAttachEnabled

      @Stability(Stable) public CfnVolume.Builder multiAttachEnabled(Boolean multiAttachEnabled)
      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.

      Parameters:
      multiAttachEnabled - Indicates whether Amazon EBS Multi-Attach is enabled. This parameter is required.
      Returns:
      this
      See Also:

    • multiAttachEnabled

      @Stability(Stable) public CfnVolume.Builder multiAttachEnabled(IResolvable multiAttachEnabled)
      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.

      Parameters:
      multiAttachEnabled - Indicates whether Amazon EBS Multi-Attach is enabled. This parameter is required.
      Returns:
      this
      See Also:

    • outpostArn

      @Stability(Stable) public CfnVolume.Builder outpostArn(String outpostArn)
      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.

      Parameters:
      outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the volume. This parameter is required.
      Returns:
      this
      See Also:

    • size

      @Stability(Stable) public CfnVolume.Builder size(Number size)
      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

      Parameters:
      size - The size of the volume, in GiBs. This parameter is required.
      Returns:
      this
      See Also:

    • snapshotId

      @Stability(Stable) public CfnVolume.Builder snapshotId(String snapshotId)
      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.

      Parameters:
      snapshotId - The snapshot from which to create the volume. This parameter is required.
      Returns:
      this
      See Also:

    • sourceVolumeId

      @Stability(Stable) public CfnVolume.Builder sourceVolumeId(String sourceVolumeId)
      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,

      Parameters:
      sourceVolumeId - The ID of the source EBS volume to copy. This parameter is required.
      Returns:
      this
      See Also:

    • tags

      @Stability(Stable) public CfnVolume.Builder tags(List<? extends CfnTag> tags)
      The tags to apply to the volume during creation.

      Parameters:
      tags - The tags to apply to the volume during creation. This parameter is required.
      Returns:
      this
      See Also:

    • throughput

      @Stability(Stable) public CfnVolume.Builder throughput(Number throughput)
      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.

      Parameters:
      throughput - The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is required.
      Returns:
      this
      See Also:

    • volumeInitializationRate

      @Stability(Stable) public CfnVolume.Builder volumeInitializationRate(Number volumeInitializationRate)
      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

      Parameters:
      volumeInitializationRate - 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 parameter is required.
      Returns:
      this
      See Also:

    • volumeType

      @Stability(Stable) public CfnVolume.Builder volumeType(String volumeType)
      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

      Parameters:
      volumeType - The volume type. This parameter can be one of the following values:. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Stable) public CfnVolume build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnVolume>
      Returns:
      a newly built instance of CfnVolume.