Package software.amazon.awscdk.services.storagegateway

Class CfnTape.Builder

java.lang.Object

software.amazon.awscdk.services.storagegateway.CfnTape.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTape>

Enclosing class:

CfnTape

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

A fluent builder for CfnTape.

Method Summary

Modifier and Type	Method	Description
CfnTape	build()
static CfnTape.Builder	create(software.constructs.Construct scope, String id)
CfnTape.Builder	gatewayArn(String gatewayArn)	The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape.
CfnTape.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.
CfnTape.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.
CfnTape.Builder	kmsKey(String kmsKey)	The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
CfnTape.Builder	poolId(String poolId)	The ID of the pool that you want to add your tape to for archiving.
CfnTape.Builder	tags(List<? extends CfnTag> tags)	A list of up to 50 tags to assign to the virtual tape.
CfnTape.Builder	tapeBarcode(String tapeBarcode)	The barcode that you want to assign to the virtual tape.
CfnTape.Builder	tapeSizeInBytes(Number tapeSizeInBytes)	The size, in bytes, of the virtual tape that you want to create.
CfnTape.Builder	worm(Boolean worm)	Set to true to create a write-once-read-many (WORM) virtual tape.
CfnTape.Builder	worm(IResolvable worm)	Set to true to create a write-once-read-many (WORM) virtual tape.

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 CfnTape.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 CfnTape.Builder.

gatewayArn

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

The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape.

Parameters:

gatewayArn - The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape. This parameter is required.

Returns:

this

See Also:

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

tapeSizeInBytes

@Stability(Stable)
public CfnTape.Builder tapeSizeInBytes(Number tapeSizeInBytes)

The size, in bytes, of the virtual tape that you want to create.

Parameters:

tapeSizeInBytes - The size, in bytes, of the virtual tape that you want to create. This parameter is required.

Returns:

this

See Also:

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

kmsEncrypted

@Stability(Stable)
public CfnTape.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.

Optional.

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-tape.html#cfn-storagegateway-tape-kmsencrypted

kmsEncrypted

@Stability(Stable)
public CfnTape.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.

Optional.

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-tape.html#cfn-storagegateway-tape-kmsencrypted

kmsKey

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

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

This value must be set if KMSEncrypted is true.

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-tape.html#cfn-storagegateway-tape-kmskey

poolId

@Stability(Stable)
public CfnTape.Builder poolId(String poolId)

The ID of the pool that you want to add your tape to for archiving.

Tapes in this pool are archived in the S3 storage class that is associated with the pool.

Parameters:

poolId - The ID of the pool that you want to add your tape to for archiving. This parameter is required.

Returns:

this

See Also:

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

tags

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

A list of up to 50 tags to assign to the virtual tape.

Parameters:

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

Returns:

this

See Also:

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

tapeBarcode

@Stability(Stable)
public CfnTape.Builder tapeBarcode(String tapeBarcode)

The barcode that you want to assign to the virtual tape.

Barcodes cannot be reused, even after a tape is deleted.

Parameters:

tapeBarcode - The barcode that you want to assign to the virtual tape. This parameter is required.

Returns:

this

See Also:

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

worm

@Stability(Stable)
public CfnTape.Builder worm(Boolean worm)

Set to true to create a write-once-read-many (WORM) virtual tape.

Parameters:

worm - Set to true to create a write-once-read-many (WORM) virtual tape. This parameter is required.

Returns:

this

See Also:

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

worm

@Stability(Stable)
public CfnTape.Builder worm(IResolvable worm)

Set to true to create a write-once-read-many (WORM) virtual tape.

Parameters:

worm - Set to true to create a write-once-read-many (WORM) virtual tape. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTape build()

Specified by:

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

Returns:

a newly built instance of CfnTape.