Package software.amazon.awscdk.services.storagegateway

Class CfnVolumeProps.Builder

java.lang.Object

software.amazon.awscdk.services.storagegateway.CfnVolumeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVolumeProps>

Enclosing interface:

CfnVolumeProps

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

A builder for CfnVolumeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnVolumeProps	build()	Builds the configured instance.
CfnVolumeProps.Builder	gatewayArn(String gatewayArn)	Sets the value of CfnVolumeProps.getGatewayArn()
CfnVolumeProps.Builder	kmsEncrypted(Boolean kmsEncrypted)	Sets the value of CfnVolumeProps.getKmsEncrypted()
CfnVolumeProps.Builder	kmsEncrypted(IResolvable kmsEncrypted)	Sets the value of CfnVolumeProps.getKmsEncrypted()
CfnVolumeProps.Builder	kmsKey(String kmsKey)	Sets the value of CfnVolumeProps.getKmsKey()
CfnVolumeProps.Builder	networkInterfaceId(String networkInterfaceId)	Sets the value of CfnVolumeProps.getNetworkInterfaceId()
CfnVolumeProps.Builder	snapshotId(String snapshotId)	Sets the value of CfnVolumeProps.getSnapshotId()
CfnVolumeProps.Builder	sourceVolumeArn(String sourceVolumeArn)	Sets the value of CfnVolumeProps.getSourceVolumeArn()
CfnVolumeProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnVolumeProps.getTags()
CfnVolumeProps.Builder	targetName(String targetName)	Sets the value of CfnVolumeProps.getTargetName()
CfnVolumeProps.Builder	volumeSizeInBytes(Number volumeSizeInBytes)	Sets the value of CfnVolumeProps.getVolumeSizeInBytes()

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

gatewayArn

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

Sets the value of CfnVolumeProps.getGatewayArn()

Parameters:

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

Returns:

this

networkInterfaceId

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

Sets the value of CfnVolumeProps.getNetworkInterfaceId()

Parameters:

networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. This parameter is required. Only IPv4 addresses are accepted.

Returns:

this

targetName

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

Sets the value of CfnVolumeProps.getTargetName()

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

volumeSizeInBytes

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

Sets the value of CfnVolumeProps.getVolumeSizeInBytes()

Parameters:

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

Returns:

this

kmsEncrypted

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

Sets the value of CfnVolumeProps.getKmsEncrypted()

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.

Returns:

this

kmsEncrypted

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

Sets the value of CfnVolumeProps.getKmsEncrypted()

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.

Returns:

this

kmsKey

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

Sets the value of CfnVolumeProps.getKmsKey()

Parameters:

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

Returns:

this

snapshotId

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

Sets the value of CfnVolumeProps.getSnapshotId()

Parameters:

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

Returns:

this

sourceVolumeArn

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

Sets the value of CfnVolumeProps.getSourceVolumeArn()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnVolumeProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnVolumeProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnVolumeProps

Throws:

NullPointerException - if any required attribute was not provided