software.amazon.awscdk.services.ec2

Class EbsDeviceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.EbsDeviceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EbsDeviceProps>

Enclosing interface:

EbsDeviceProps

@Stability(value=Stable)
public static final class EbsDeviceProps.Builder
extends Object
implements software.amazon.jsii.Builder<EbsDeviceProps>

A builder for EbsDeviceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EbsDeviceProps	build() Builds the configured instance.
EbsDeviceProps.Builder	deleteOnTermination(Boolean deleteOnTermination) Sets the value of EbsDeviceProps.getDeleteOnTermination()
EbsDeviceProps.Builder	encrypted(Boolean encrypted) Sets the value of EbsDeviceOptions.getEncrypted()
EbsDeviceProps.Builder	iops(Number iops) Sets the value of EbsDeviceProps.getIops()
EbsDeviceProps.Builder	kmsKey(IKey kmsKey) Sets the value of EbsDeviceOptions.getKmsKey()
EbsDeviceProps.Builder	snapshotId(String snapshotId) Sets the value of EbsDeviceProps.getSnapshotId()
EbsDeviceProps.Builder	volumeSize(Number volumeSize) Sets the value of EbsDeviceSnapshotOptions.getVolumeSize()
EbsDeviceProps.Builder	volumeType(EbsDeviceVolumeType volumeType) Sets the value of EbsDeviceProps.getVolumeType()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

snapshotId

@Stability(value=Stable)
public EbsDeviceProps.Builder snapshotId(String snapshotId)

Sets the value of EbsDeviceProps.getSnapshotId()

Parameters:

snapshotId - The snapshot ID of the volume to use.

Returns:

this

volumeSize

@Stability(value=Stable)
public EbsDeviceProps.Builder volumeSize(Number volumeSize)

Sets the value of EbsDeviceSnapshotOptions.getVolumeSize()

Parameters:

volumeSize - The volume size, in Gibibytes (GiB). If you specify volumeSize, it must be equal or greater than the size of the snapshot.

Returns:

this

deleteOnTermination

@Stability(value=Stable)
public EbsDeviceProps.Builder deleteOnTermination(Boolean deleteOnTermination)

Sets the value of EbsDeviceProps.getDeleteOnTermination()

Parameters:

deleteOnTermination - Indicates whether to delete the volume when the instance is terminated.

Returns:

this

iops

@Stability(value=Stable)
public EbsDeviceProps.Builder iops(Number iops)

Sets the value of EbsDeviceProps.getIops()

Parameters:

iops - The number of I/O operations per second (IOPS) to provision for the volume. Must only be set for {@link volumeType}: {@link EbsDeviceVolumeType.IO1}

The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.

Returns:

this

volumeType

@Stability(value=Stable)
public EbsDeviceProps.Builder volumeType(EbsDeviceVolumeType volumeType)

Sets the value of EbsDeviceProps.getVolumeType()

Parameters:

volumeType - The EBS volume type.

Returns:

this

encrypted

@Stability(value=Stable)
public EbsDeviceProps.Builder encrypted(Boolean encrypted)

Sets the value of EbsDeviceOptions.getEncrypted()

Parameters:

encrypted - Specifies whether the EBS volume is encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption

Returns:

this

kmsKey

@Stability(value=Stable)
public EbsDeviceProps.Builder kmsKey(IKey kmsKey)

Sets the value of EbsDeviceOptions.getKmsKey()

Parameters:

kmsKey - The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.

Returns:

this

build

@Stability(value=Stable)
public EbsDeviceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EbsDeviceProps>

Returns:

a new instance of EbsDeviceProps

Throws:

NullPointerException - if any required attribute was not provided