Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnLaunchTemplatePropsMixin.EbsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnLaunchTemplatePropsMixin.EbsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLaunchTemplatePropsMixin.EbsProperty>

Enclosing interface:

CfnLaunchTemplatePropsMixin.EbsProperty

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

A builder for CfnLaunchTemplatePropsMixin.EbsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLaunchTemplatePropsMixin.EbsProperty	build()	Builds the configured instance.
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	deleteOnTermination(Boolean deleteOnTermination)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getDeleteOnTermination()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	deleteOnTermination(IResolvable deleteOnTermination)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getDeleteOnTermination()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	ebsCardIndex(Number ebsCardIndex)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEbsCardIndex()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	encrypted(Boolean encrypted)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEncrypted()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	encrypted(IResolvable encrypted)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEncrypted()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	iops(Number iops)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getIops()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getKmsKeyId()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	kmsKeyId(IKeyRef kmsKeyId)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getKmsKeyId()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	snapshotId(String snapshotId)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getSnapshotId()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	throughput(Number throughput)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getThroughput()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	volumeInitializationRate(Number volumeInitializationRate)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getVolumeInitializationRate()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	volumeSize(Number volumeSize)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getVolumeSize()
CfnLaunchTemplatePropsMixin.EbsProperty.Builder	volumeType(String volumeType)	Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.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 CfnLaunchTemplatePropsMixin.EbsProperty.Builder deleteOnTermination(Boolean deleteOnTermination)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getDeleteOnTermination()

Parameters:

deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

Returns:

this

deleteOnTermination

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder deleteOnTermination(IResolvable deleteOnTermination)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getDeleteOnTermination()

Parameters:

deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

Returns:

this

ebsCardIndex

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder ebsCardIndex(Number ebsCardIndex)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEbsCardIndex()

Parameters:

ebsCardIndex - the value to be set.

Returns:

this

encrypted

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder encrypted(Boolean encrypted)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEncrypted()

Parameters:

encrypted - Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Returns:

this

encrypted

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder encrypted(IResolvable encrypted)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getEncrypted()

Parameters:

encrypted - Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

Returns:

this

iops

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder iops(Number iops)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getIops()

Parameters:

iops - 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 - 80,000 IOPS
• io1 : 100 - 64,000 IOPS
• io2 : 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System . On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is supported for io1 , io2 , and gp3 volumes only.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getKmsKeyId()

Parameters:

kmsKeyId - Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder kmsKeyId(IKeyRef kmsKeyId)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getKmsKeyId()

Parameters:

kmsKeyId - Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

Returns:

this

snapshotId

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder snapshotId(String snapshotId)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getSnapshotId()

Parameters:

snapshotId - The ID of the snapshot.

Returns:

this

throughput

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder throughput(Number throughput)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getThroughput()

Parameters:

throughput - The throughput to provision for a gp3 volume, with a maximum of 2,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 2,000.

Returns:

this

volumeInitializationRate

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder volumeInitializationRate(Number volumeInitializationRate)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getVolumeInitializationRate()

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

Returns:

this

volumeSize

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder volumeSize(Number volumeSize)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getVolumeSize()

Parameters:

volumeSize - The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

• 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

Returns:

this

volumeType

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty.Builder volumeType(String volumeType)

Sets the value of CfnLaunchTemplatePropsMixin.EbsProperty.getVolumeType()

Parameters:

volumeType - The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

Returns:

this

build

@Stability(Stable)
public CfnLaunchTemplatePropsMixin.EbsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLaunchTemplatePropsMixin.EbsProperty>

Returns:

a new instance of CfnLaunchTemplatePropsMixin.EbsProperty

Throws:

NullPointerException - if any required attribute was not provided