Interface ActivateGatewayRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ActivateGatewayRequest.Builder,
,ActivateGatewayRequest> SdkBuilder<ActivateGatewayRequest.Builder,
,ActivateGatewayRequest> SdkPojo
,SdkRequest.Builder
,StorageGatewayRequest.Builder
- Enclosing class:
ActivateGatewayRequest
-
Method Summary
Modifier and TypeMethodDescriptionactivationKey
(String activationKey) Your gateway activation key.gatewayName
(String gatewayName) The name you configured for your gateway.gatewayRegion
(String gatewayRegion) A value that indicates the Amazon Web Services Region where you want to store your data.gatewayTimezone
(String gatewayTimezone) A value that indicates the time zone you want to set for the gateway.gatewayType
(String gatewayType) A value that defines the type of gateway to activate.mediumChangerType
(String mediumChangerType) The value that indicates the type of medium changer to use for tape gateway.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) A list of up to 50 tags that you can assign to the gateway.tags
(Consumer<Tag.Builder>... tags) A list of up to 50 tags that you can assign to the gateway.A list of up to 50 tags that you can assign to the gateway.tapeDriveType
(String tapeDriveType) The value that indicates the type of tape drive to use for tape gateway.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.Builder
build
-
Method Details
-
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 theActivateGateway
API call determine the actual configuration of your gateway.For more information, see Getting activation key 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 parameteractivationKey
. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to theActivateGateway
API call determine the actual configuration of your gateway.For more information, see Getting activation key in the Storage Gateway User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your
Host
header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
- Parameters:
gatewayRegion
- A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in yourHost
header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
|VTL_SNOW
|FILE_S3
|FILE_FSX_SMB
- 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 isCACHED
.Valid Values:
STORED
|CACHED
|VTL
|VTL_SNOW
|FILE_S3
|FILE_FSX_SMB
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
|IBM-03584L32-0402
- 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
|IBM-03584L32-0402
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
- Parameters:
tags
- A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
- Parameters:
tags
- A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ActivateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-