software.amazon.awssdk.services.storagegateway.model

Interface CreateTapesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTapesRequest.Builder,CreateTapesRequest>, SdkBuilder<CreateTapesRequest.Builder,CreateTapesRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder

Enclosing class:

CreateTapesRequest

public static interface CreateTapesRequest.Builder
extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateTapesRequest.Builder,CreateTapesRequest>

Method Summary

Modifier and Type	Method and Description
CreateTapesRequest.Builder	clientToken(String clientToken) A unique identifier that you use to retry a request.
CreateTapesRequest.Builder	gatewayARN(String gatewayARN) The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with.
CreateTapesRequest.Builder	kmsEncrypted(Boolean kmsEncrypted) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
CreateTapesRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
CreateTapesRequest.Builder	numTapesToCreate(Integer numTapesToCreate) The number of virtual tapes that you want to create.
CreateTapesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateTapesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateTapesRequest.Builder	tapeBarcodePrefix(String tapeBarcodePrefix) A prefix that you append to the barcode of the virtual tape you are creating.
CreateTapesRequest.Builder	tapeSizeInBytes(Long tapeSizeInBytes) The size, in bytes, of the virtual tapes that you want to create.

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

gatewayARN

CreateTapesRequest.Builder gatewayARN(String gatewayARN)

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.

Parameters:

gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

Returns a reference to this object so that method calls can be chained together.

tapeSizeInBytes

CreateTapesRequest.Builder tapeSizeInBytes(Long tapeSizeInBytes)

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

The size must be aligned by gigabyte (1024*1024*1024 byte).

Parameters:

tapeSizeInBytes - The size, in bytes, of the virtual tapes that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 byte).

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateTapesRequest.Builder clientToken(String clientToken)

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Using the same ClientToken prevents creating the tape multiple times.

Parameters:

clientToken - A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Using the same ClientToken prevents creating the tape multiple times.

Returns:

Returns a reference to this object so that method calls can be chained together.

numTapesToCreate

CreateTapesRequest.Builder numTapesToCreate(Integer numTapesToCreate)

The number of virtual tapes that you want to create.

Parameters:

numTapesToCreate - The number of virtual tapes that you want to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

tapeBarcodePrefix

CreateTapesRequest.Builder tapeBarcodePrefix(String tapeBarcodePrefix)

A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.

Parameters:

tapeBarcodePrefix - A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsEncrypted

CreateTapesRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Parameters:

kmsEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKey

CreateTapesRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Parameters:

kmsKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateTapesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateTapesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.