software.amazon.awscdk.services.ec2

Class EbsDeviceOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.EbsDeviceOptions.Builder

Enclosing interface:

EbsDeviceOptions

public static final class EbsDeviceOptions.Builder
extends java.lang.Object

A builder for EbsDeviceOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EbsDeviceOptions	build() Builds the configured instance.
EbsDeviceOptions.Builder	deleteOnTermination(java.lang.Boolean deleteOnTermination) Sets the value of EbsDeviceOptionsBase.getDeleteOnTermination()
EbsDeviceOptions.Builder	encrypted(java.lang.Boolean encrypted) Sets the value of EbsDeviceOptions.getEncrypted()
EbsDeviceOptions.Builder	iops(java.lang.Number iops) Sets the value of EbsDeviceOptionsBase.getIops()
EbsDeviceOptions.Builder	kmsKey(IKey kmsKey) Sets the value of EbsDeviceOptions.getKmsKey()
EbsDeviceOptions.Builder	volumeType(EbsDeviceVolumeType volumeType) Sets the value of EbsDeviceOptionsBase.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

encrypted

public EbsDeviceOptions.Builder encrypted(java.lang.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

public EbsDeviceOptions.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

deleteOnTermination

public EbsDeviceOptions.Builder deleteOnTermination(java.lang.Boolean deleteOnTermination)

Sets the value of EbsDeviceOptionsBase.getDeleteOnTermination()

Parameters:

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

Returns:

this

iops

public EbsDeviceOptions.Builder iops(java.lang.Number iops)

Sets the value of EbsDeviceOptionsBase.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

public EbsDeviceOptions.Builder volumeType(EbsDeviceVolumeType volumeType)

Sets the value of EbsDeviceOptionsBase.getVolumeType()

Parameters:

volumeType - The EBS volume type.

Returns:

this

build

public EbsDeviceOptions build()

Builds the configured instance.

Returns:

a new instance of EbsDeviceOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided