java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnLaunchConfiguration.BlockDeviceProperty.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnLaunchConfiguration.BlockDeviceProperty>

Enclosing interface:: CfnLaunchConfiguration.BlockDeviceProperty

@Stability(Stable) public static final class CfnLaunchConfiguration.BlockDeviceProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnLaunchConfiguration.BlockDeviceProperty>

A builder for CfnLaunchConfiguration.BlockDeviceProperty

Constructor Summary

Constructors

Constructor

Description

Builder()
Method Summary

Modifier and Type

Method

Description

CfnLaunchConfiguration.BlockDeviceProperty

build()

Builds the configured instance.

CfnLaunchConfiguration.BlockDeviceProperty.Builder

deleteOnTermination(Boolean deleteOnTermination)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getDeleteOnTermination()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

deleteOnTermination(IResolvable deleteOnTermination)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getDeleteOnTermination()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

encrypted(Boolean encrypted)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getEncrypted()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

encrypted(IResolvable encrypted)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getEncrypted()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

iops(Number iops)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getIops()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

snapshotId(String snapshotId)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getSnapshotId()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

throughput(Number throughput)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getThroughput()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

volumeSize(Number volumeSize)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getVolumeSize()

CfnLaunchConfiguration.BlockDeviceProperty.Builder

volumeType(String volumeType)

Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getVolumeType()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Builder
  
  public Builder()
Method Details
- deleteOnTermination
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder deleteOnTermination(Boolean deleteOnTermination)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getDeleteOnTermination()
  
  Parameters:
  
  deleteOnTermination - Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .
  
  Returns:
  
  this
- deleteOnTermination
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder deleteOnTermination(IResolvable deleteOnTermination)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getDeleteOnTermination()
  
  Parameters:
  
  deleteOnTermination - Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .
  
  Returns:
  
  this
- encrypted
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder encrypted(Boolean encrypted)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getEncrypted()
  
  Parameters:
  
  encrypted - Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
  
  If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
  If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the AWS managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
  For more information, see Use AWS KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide .
  
  Returns:
  
  this
- encrypted
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder encrypted(IResolvable encrypted)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getEncrypted()
  
  Parameters:
  
  encrypted - Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
  
  If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
  If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the AWS managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
  For more information, see Use AWS KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide .
  
  Returns:
  
  this
- iops
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder iops(Number iops)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getIops()
  Parameters:
  
  iops - The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 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
  
  For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.
  Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)
  
  Returns:
  
  this
- snapshotId
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder snapshotId(String snapshotId)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getSnapshotId()
  
  Parameters:
  
  snapshotId - The snapshot ID of the volume to use. You must specify either a VolumeSize or a SnapshotId .
  
  Returns:
  
  this
- throughput
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder throughput(Number throughput)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getThroughput()
  
  Parameters:
  
  throughput - The throughput (MiBps) to provision for a gp3 volume.
  
  Returns:
  
  this
- volumeSize
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder volumeSize(Number volumeSize)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getVolumeSize()
  Parameters:
  
  volumeSize - The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.
  
  gp2 and gp3 : 1-16,384
  
  io1 : 4-16,384
  
  st1 and sc1 : 125-16,384
  
  standard : 1-1,024
  
  You must specify either a SnapshotId or a VolumeSize . If you specify both SnapshotId and VolumeSize , the volume size must be equal or greater than the size of the snapshot.
  
  Returns:
  
  this
- volumeType
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty.Builder volumeType(String volumeType)
  
  Sets the value of CfnLaunchConfiguration.BlockDeviceProperty.getVolumeType()
  
  Parameters:
  
  volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances .
  Valid values: standard | io1 | gp2 | st1 | sc1 | gp3
  
  Returns:
  
  this
- build
  
  @Stability(Stable) public CfnLaunchConfiguration.BlockDeviceProperty build()
  
  Builds the configured instance.
  
  Specified by:
  
  build in interface software.amazon.jsii.Builder<CfnLaunchConfiguration.BlockDeviceProperty>
  
  Returns:
  
  a new instance of CfnLaunchConfiguration.BlockDeviceProperty
  
  Throws:
  
  NullPointerException - if any required attribute was not provided

Class CfnLaunchConfiguration.BlockDeviceProperty.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Builder

Method Details

deleteOnTermination

deleteOnTermination

encrypted

encrypted

iops

snapshotId

throughput

volumeSize

volumeType

build