Package software.amazon.awscdk.services.workspacesinstances

Class CfnVolume.Builder

java.lang.Object

software.amazon.awscdk.services.workspacesinstances.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 Summary

Modifier and Type	Method	Description
CfnVolume.Builder	availabilityZone(String availabilityZone)	The Availability Zone in which to create the volume.
CfnVolume	build()
static CfnVolume.Builder	create(software.constructs.Construct scope, String id)
CfnVolume.Builder	encrypted(Boolean encrypted)	Indicates whether the volume should be encrypted.
CfnVolume.Builder	encrypted(IResolvable encrypted)	Indicates whether the volume should be encrypted.
CfnVolume.Builder	iops(Number iops)	The number of I/O operations per second (IOPS).
CfnVolume.Builder	kmsKeyId(String kmsKeyId)	The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
CfnVolume.Builder	sizeInGb(Number sizeInGb)	The size of the volume, in GiBs.
CfnVolume.Builder	snapshotId(String snapshotId)	The snapshot from which to create the volume.
CfnVolume.Builder	tagSpecifications(List<? extends Object> tagSpecifications)	The tags passed to EBS volume.
CfnVolume.Builder	tagSpecifications(IResolvable tagSpecifications)	The tags passed to EBS volume.
CfnVolume.Builder	throughput(Number throughput)	The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
CfnVolume.Builder	volumeType(String volumeType)	The volume type.

Methods inherited from class java.lang.Object

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

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.

availabilityZone

@Stability(Stable)
public CfnVolume.Builder availabilityZone(String availabilityZone)

The Availability Zone in which to create the volume.

Parameters:

availabilityZone - The Availability Zone in which to create the volume. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-availabilityzone

encrypted

@Stability(Stable)
public CfnVolume.Builder encrypted(Boolean encrypted)

Indicates whether the volume should be encrypted.

Parameters:

encrypted - Indicates whether the volume should be encrypted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-encrypted

encrypted

@Stability(Stable)
public CfnVolume.Builder encrypted(IResolvable encrypted)

Indicates whether the volume should be encrypted.

Parameters:

encrypted - Indicates whether the volume should be encrypted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-encrypted

iops

@Stability(Stable)
public CfnVolume.Builder iops(Number iops)

The number of I/O operations per second (IOPS).

Parameters:

iops - The number of I/O operations per second (IOPS). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-iops

kmsKeyId

@Stability(Stable)
public CfnVolume.Builder kmsKeyId(String kmsKeyId)

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.

Parameters:

kmsKeyId - The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-kmskeyid

sizeInGb

@Stability(Stable)
public CfnVolume.Builder sizeInGb(Number sizeInGb)

The size of the volume, in GiBs.

Parameters:

sizeInGb - The size of the volume, in GiBs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-sizeingb

snapshotId

@Stability(Stable)
public CfnVolume.Builder snapshotId(String snapshotId)

The snapshot from which to create the volume.

Parameters:

snapshotId - The snapshot from which to create the volume. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-snapshotid

tagSpecifications

@Stability(Stable)
public CfnVolume.Builder tagSpecifications(IResolvable tagSpecifications)

The tags passed to EBS volume.

Parameters:

tagSpecifications - The tags passed to EBS volume. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-tagspecifications

tagSpecifications

@Stability(Stable)
public CfnVolume.Builder tagSpecifications(List<? extends Object> tagSpecifications)

The tags passed to EBS volume.

Parameters:

tagSpecifications - The tags passed to EBS volume. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-tagspecifications

throughput

@Stability(Stable)
public CfnVolume.Builder throughput(Number throughput)

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-throughput

volumeType

@Stability(Stable)
public CfnVolume.Builder volumeType(String volumeType)

The volume type.

Parameters:

volumeType - The volume type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesinstances-volume.html#cfn-workspacesinstances-volume-volumetype

build

@Stability(Stable)
public CfnVolume build()

Specified by:

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

Returns:

a newly built instance of CfnVolume.