Package software.amazon.awscdk.cfnpropertymixins.services.storagegateway

Class CfnVolumePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.storagegateway.CfnVolumePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVolumePropsMixin>

Enclosing class:

CfnVolumePropsMixin

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

A fluent builder for CfnVolumePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnVolumePropsMixin	build()
static CfnVolumePropsMixin.Builder	create()
static CfnVolumePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnVolumePropsMixin.Builder	gatewayArn(String gatewayArn)	The Amazon Resource Name (ARN) of the gateway on which to create the volume.
CfnVolumePropsMixin.Builder	kmsEncrypted(Boolean kmsEncrypted)	Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
CfnVolumePropsMixin.Builder	kmsEncrypted(IResolvable kmsEncrypted)	Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
CfnVolumePropsMixin.Builder	kmsKey(String kmsKey)	The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
CfnVolumePropsMixin.Builder	networkInterfaceId(String networkInterfaceId)	The network interface of the gateway on which to expose the iSCSI target.
CfnVolumePropsMixin.Builder	snapshotId(String snapshotId)	The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
CfnVolumePropsMixin.Builder	sourceVolumeArn(String sourceVolumeArn)	The ARN of an existing volume from which to create the new volume.
CfnVolumePropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of up to 50 tags to assign to the volume.
CfnVolumePropsMixin.Builder	targetName(String targetName)	The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
CfnVolumePropsMixin.Builder	volumeSizeInBytes(Number volumeSizeInBytes)	The size of the volume in bytes.

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 CfnVolumePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnVolumePropsMixin.Builder.

create

@Stability(Stable)
public static CfnVolumePropsMixin.Builder create()

Returns:

a new instance of CfnVolumePropsMixin.Builder.

gatewayArn

@Stability(Stable)
public CfnVolumePropsMixin.Builder gatewayArn(String gatewayArn)

The Amazon Resource Name (ARN) of the gateway on which to create the volume.

Parameters:

gatewayArn - The Amazon Resource Name (ARN) of the gateway on which to create the volume. This parameter is required.

Returns:

this

See Also:

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

kmsEncrypted

@Stability(Stable)
public CfnVolumePropsMixin.Builder kmsEncrypted(Boolean kmsEncrypted)

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.

Parameters:

kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. This parameter is required.

Returns:

this

See Also:

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

kmsEncrypted

@Stability(Stable)
public CfnVolumePropsMixin.Builder kmsEncrypted(IResolvable kmsEncrypted)

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.

Parameters:

kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. This parameter is required.

Returns:

this

See Also:

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

kmsKey

@Stability(Stable)
public CfnVolumePropsMixin.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

Parameters:

kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. This parameter is required.

Returns:

this

See Also:

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

networkInterfaceId

@Stability(Stable)
public CfnVolumePropsMixin.Builder networkInterfaceId(String networkInterfaceId)

The network interface of the gateway on which to expose the iSCSI target.

Only IPv4 addresses are accepted.

Parameters:

networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. This parameter is required.

Returns:

this

See Also:

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

snapshotId

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

The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).

Parameters:

snapshotId - The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb). This parameter is required.

Returns:

this

See Also:

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

sourceVolumeArn

@Stability(Stable)
public CfnVolumePropsMixin.Builder sourceVolumeArn(String sourceVolumeArn)

The ARN of an existing volume from which to create the new volume.

Parameters:

sourceVolumeArn - The ARN of an existing volume from which to create the new volume. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnVolumePropsMixin.Builder tags(List<? extends CfnTag> tags)

A list of up to 50 tags to assign to the volume.

Parameters:

tags - A list of up to 50 tags to assign to the volume. This parameter is required.

Returns:

this

See Also:

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

targetName

@Stability(Stable)
public CfnVolumePropsMixin.Builder targetName(String targetName)

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.

Parameters:

targetName - The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. This parameter is required.

Returns:

this

See Also:

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

volumeSizeInBytes

@Stability(Stable)
public CfnVolumePropsMixin.Builder volumeSizeInBytes(Number volumeSizeInBytes)

The size of the volume in bytes.

Parameters:

volumeSizeInBytes - The size of the volume in bytes. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnVolumePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnVolumePropsMixin.