software.amazon.awssdk.services.storagegateway.model

Interface ActivateGatewayRequest.Builder

All Superinterfaces:

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

Enclosing class:

ActivateGatewayRequest

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

Method Summary

Modifier and Type	Method and Description
ActivateGatewayRequest.Builder	activationKey(String activationKey) Your gateway activation key.
ActivateGatewayRequest.Builder	gatewayName(String gatewayName) The name you configured for your gateway.
ActivateGatewayRequest.Builder	gatewayRegion(String gatewayRegion) A value that indicates the region where you want to store your data.
ActivateGatewayRequest.Builder	gatewayTimezone(String gatewayTimezone) A value that indicates the time zone you want to set for the gateway.
ActivateGatewayRequest.Builder	gatewayType(String gatewayType) A value that defines the type of gateway to activate.
ActivateGatewayRequest.Builder	mediumChangerType(String mediumChangerType) The value that indicates the type of medium changer to use for tape gateway.
ActivateGatewayRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ActivateGatewayRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ActivateGatewayRequest.Builder	tapeDriveType(String tapeDriveType) The value that indicates the type of tape drive to use for tape gateway.

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

activationKey

ActivateGatewayRequest.Builder activationKey(String activationKey)

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

Parameters:

activationKey - Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

Returns:

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

gatewayName

ActivateGatewayRequest.Builder gatewayName(String gatewayName)

The name you configured for your gateway.

Parameters:

gatewayName - The name you configured for your gateway.

Returns:

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

gatewayTimezone

ActivateGatewayRequest.Builder gatewayTimezone(String gatewayTimezone)

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Parameters:

gatewayTimezone - A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Returns:

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

gatewayRegion

ActivateGatewayRequest.Builder gatewayRegion(String gatewayRegion)

A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"

Parameters:

gatewayRegion - A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"

Returns:

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

gatewayType

ActivateGatewayRequest.Builder gatewayType(String gatewayType)

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

Parameters:

gatewayType - A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

Returns:

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

tapeDriveType

ActivateGatewayRequest.Builder tapeDriveType(String tapeDriveType)

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: "IBM-ULT3580-TD5"

Parameters:

tapeDriveType - The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: "IBM-ULT3580-TD5"

Returns:

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

mediumChangerType

ActivateGatewayRequest.Builder mediumChangerType(String mediumChangerType)

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: "STK-L700", "AWS-Gateway-VTL"

Parameters:

mediumChangerType - The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: "STK-L700", "AWS-Gateway-VTL"

Returns:

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

overrideConfiguration

ActivateGatewayRequest.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

ActivateGatewayRequest.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.