public class ActivateGatewayRequest extends AmazonWebServiceRequest implements java.io.Serializable
ActivateGateway operation.
This operation activates the gateway you previously deployed on your VMware host. For more information, see Downloading and Deploying AWS Storage Gateway VM . In the activation process you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots and the gateway schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account (see UpdateGatewayInformation).
NOTE:You must power on the gateway VM before you can activate your gateway.
| コンストラクタと説明 |
|---|
ActivateGatewayRequest() |
| 修飾子とタイプ | メソッドと説明 |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getActivationKey()
Your gateway activation key.
|
java.lang.String |
getGatewayName()
A unique identifier for your gateway.
|
java.lang.String |
getGatewayRegion()
One of the values that indicates the region where you want to store
the snapshot backups.
|
java.lang.String |
getGatewayTimezone()
One of the values that indicates the time zone you want to set for the
gateway.
|
java.lang.String |
getGatewayType()
One of the values that defines the type of gateway to activate.
|
int |
hashCode() |
void |
setActivationKey(java.lang.String activationKey)
Your gateway activation key.
|
void |
setGatewayName(java.lang.String gatewayName)
A unique identifier for your gateway.
|
void |
setGatewayRegion(java.lang.String gatewayRegion)
One of the values that indicates the region where you want to store
the snapshot backups.
|
void |
setGatewayTimezone(GatewayTimezone gatewayTimezone)
One of the values that indicates the time zone you want to set for the
gateway.
|
void |
setGatewayTimezone(java.lang.String gatewayTimezone)
One of the values that indicates the time zone you want to set for the
gateway.
|
void |
setGatewayType(GatewayType gatewayType)
One of the values that defines the type of gateway to activate.
|
void |
setGatewayType(java.lang.String gatewayType)
One of the values that defines the type of gateway to activate.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ActivateGatewayRequest |
withActivationKey(java.lang.String activationKey)
Your gateway activation key.
|
ActivateGatewayRequest |
withGatewayName(java.lang.String gatewayName)
A unique identifier for your gateway.
|
ActivateGatewayRequest |
withGatewayRegion(java.lang.String gatewayRegion)
One of the values that indicates the region where you want to store
the snapshot backups.
|
ActivateGatewayRequest |
withGatewayTimezone(GatewayTimezone gatewayTimezone)
One of the values that indicates the time zone you want to set for the
gateway.
|
ActivateGatewayRequest |
withGatewayTimezone(java.lang.String gatewayTimezone)
One of the values that indicates the time zone you want to set for the
gateway.
|
ActivateGatewayRequest |
withGatewayType(GatewayType gatewayType)
One of the values that defines the type of gateway to activate.
|
ActivateGatewayRequest |
withGatewayType(java.lang.String gatewayType)
One of the values that defines the type of gateway to activate.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentialspublic java.lang.String getActivationKey()
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.
Constraints:
Length: 1 - 50
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.public void setActivationKey(java.lang.String activationKey)
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.
Constraints:
Length: 1 - 50
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.public ActivateGatewayRequest withActivationKey(java.lang.String activationKey)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 50
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.public java.lang.String getGatewayName()
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
public void setGatewayName(java.lang.String gatewayName)
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
gatewayName - A unique identifier for your gateway. This name becomes part of the
gateway Amazon Resources Name (ARN) which is what you use as an input
to other operations.public ActivateGatewayRequest withGatewayName(java.lang.String gatewayName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
gatewayName - A unique identifier for your gateway. This name becomes part of the
gateway Amazon Resources Name (ARN) which is what you use as an input
to other operations.public java.lang.String getGatewayTimezone()
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
GatewayTimezonepublic void setGatewayTimezone(java.lang.String gatewayTimezone)
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
gatewayTimezone - One of the values that indicates the time zone you want to set for the
gateway. The time zone is used, for example, for scheduling snapshots
and your gateway's maintenance schedule.GatewayTimezonepublic ActivateGatewayRequest withGatewayTimezone(java.lang.String gatewayTimezone)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
gatewayTimezone - One of the values that indicates the time zone you want to set for the
gateway. The time zone is used, for example, for scheduling snapshots
and your gateway's maintenance schedule.GatewayTimezonepublic void setGatewayTimezone(GatewayTimezone gatewayTimezone)
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
gatewayTimezone - One of the values that indicates the time zone you want to set for the
gateway. The time zone is used, for example, for scheduling snapshots
and your gateway's maintenance schedule.GatewayTimezonepublic ActivateGatewayRequest withGatewayTimezone(GatewayTimezone gatewayTimezone)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00
gatewayTimezone - One of the values that indicates the time zone you want to set for the
gateway. The time zone is used, for example, for scheduling snapshots
and your gateway's maintenance schedule.GatewayTimezonepublic java.lang.String getGatewayRegion()
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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
Constraints:
Length: 1 - 25
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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
public void setGatewayRegion(java.lang.String gatewayRegion)
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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
Constraints:
Length: 1 - 25
gatewayRegion - One of the values that indicates the region where you want to store
the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
public ActivateGatewayRequest withGatewayRegion(java.lang.String gatewayRegion)
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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 25
gatewayRegion - One of the values that indicates the region where you want to store
the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "ap-northeast-1", "ap-southest-1", "sa-east-1"
public java.lang.String getGatewayType()
STORED.
Constraints:
Allowed Values: STORED, CACHED
STORED.GatewayTypepublic void setGatewayType(java.lang.String gatewayType)
STORED.
Constraints:
Allowed Values: STORED, CACHED
gatewayType - One of the values 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
STORED.GatewayTypepublic ActivateGatewayRequest withGatewayType(java.lang.String gatewayType)
STORED.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: STORED, CACHED
gatewayType - One of the values 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
STORED.GatewayTypepublic void setGatewayType(GatewayType gatewayType)
STORED.
Constraints:
Allowed Values: STORED, CACHED
gatewayType - One of the values 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
STORED.GatewayTypepublic ActivateGatewayRequest withGatewayType(GatewayType gatewayType)
STORED.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: STORED, CACHED
gatewayType - One of the values 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
STORED.GatewayTypepublic java.lang.String toString()
toString クラス内 java.lang.ObjectObject.toString()public int hashCode()
hashCode クラス内 java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals クラス内 java.lang.Object