@Generated(value="software.amazon.awssdk:codegen") public final class ActivateGatewayRequest extends StorageGatewayRequest implements ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>
A JSON object containing one or more of the following fields:
| Modifier and Type | Class and Description |
|---|---|
static interface |
ActivateGatewayRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
activationKey()
Your gateway activation key.
|
static ActivateGatewayRequest.Builder |
builder() |
boolean |
equals(Object obj) |
String |
gatewayName()
The name you configured for your gateway.
|
String |
gatewayRegion()
A value that indicates the region where you want to store your data.
|
String |
gatewayTimezone()
A value that indicates the time zone you want to set for the gateway.
|
String |
gatewayType()
A value that defines the type of gateway to activate.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
String |
mediumChangerType()
The value that indicates the type of medium changer to use for tape gateway.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ActivateGatewayRequest.Builder> |
serializableBuilderClass() |
String |
tapeDriveType()
The value that indicates the type of tape drive to use for tape gateway.
|
ActivateGatewayRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic 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.
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.
public String gatewayName()
The name you configured for your gateway.
public 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.
public 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"
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"
public 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"
CACHED
.
Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
public 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"
Valid Values: "IBM-ULT3580-TD5"
public 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"
Valid Values: "STK-L700", "AWS-Gateway-VTL"
public ActivateGatewayRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>toBuilder in class StorageGatewayRequestpublic static ActivateGatewayRequest.Builder builder()
public static Class<? extends ActivateGatewayRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.