com.amazonaws.services.storagegateway.model

Class ActivateGatewayRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.ActivateGatewayRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ActivateGatewayRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ActivateGateway operation.

This operation activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway . In the activation process, you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

NOTE:You must turn on the gateway VM before you can activate your gateway.

See Also:

AWSStorageGateway.activateGateway(ActivateGatewayRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ActivateGatewayRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ActivateGatewayRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getActivationKey() Your gateway activation key.
String	getGatewayName() A unique identifier for your gateway.
String	getGatewayRegion() One of the values that indicates the region where you want to store the snapshot backups.
String	getGatewayTimezone() One of the values that indicates the time zone you want to set for the gateway.
String	getGatewayType() One of the values that defines the type of gateway to activate.
String	getMediumChangerType() The value that indicates the type of medium changer to use for gateway-VTL.
String	getTapeDriveType() The value that indicates the type of tape drive to use for gateway-VTL.
int	hashCode()
void	setActivationKey(String activationKey) Your gateway activation key.
void	setGatewayName(String gatewayName) A unique identifier for your gateway.
void	setGatewayRegion(String gatewayRegion) One of the values that indicates the region where you want to store the snapshot backups.
void	setGatewayTimezone(String gatewayTimezone) One of the values that indicates the time zone you want to set for the gateway.
void	setGatewayType(String gatewayType) One of the values that defines the type of gateway to activate.
void	setMediumChangerType(String mediumChangerType) The value that indicates the type of medium changer to use for gateway-VTL.
void	setTapeDriveType(String tapeDriveType) The value that indicates the type of tape drive to use for gateway-VTL.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ActivateGatewayRequest	withActivationKey(String activationKey) Your gateway activation key.
ActivateGatewayRequest	withGatewayName(String gatewayName) A unique identifier for your gateway.
ActivateGatewayRequest	withGatewayRegion(String gatewayRegion) One of the values that indicates the region where you want to store the snapshot backups.
ActivateGatewayRequest	withGatewayTimezone(String gatewayTimezone) One of the values that indicates the time zone you want to set for the gateway.
ActivateGatewayRequest	withGatewayType(String gatewayType) One of the values that defines the type of gateway to activate.
ActivateGatewayRequest	withMediumChangerType(String mediumChangerType) The value that indicates the type of medium changer to use for gateway-VTL.
ActivateGatewayRequest	withTapeDriveType(String tapeDriveType) The value that indicates the type of tape drive to use for gateway-VTL.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ActivateGatewayRequest

public ActivateGatewayRequest()

Method Detail

getActivationKey

public String getActivationKey()

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.

Constraints:
Length: 1 - 50

Returns:

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.

setActivationKey

public void setActivationKey(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.

Constraints:
Length: 1 - 50

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.

withActivationKey

public ActivateGatewayRequest withActivationKey(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.

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

Constraints:
Length: 1 - 50

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getGatewayName

public String getGatewayName()

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.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Returns:

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.

setGatewayName

public void setGatewayName(String 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.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Parameters:

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.

withGatewayName

public ActivateGatewayRequest withGatewayName(String 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.

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

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getGatewayTimezone

public String getGatewayTimezone()

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.

Constraints:
Length: 3 - 10

Returns:

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.

setGatewayTimezone

public void setGatewayTimezone(String 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.

Constraints:
Length: 3 - 10

Parameters:

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.

withGatewayTimezone

public ActivateGatewayRequest withGatewayTimezone(String 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.

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

Constraints:
Length: 3 - 10

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getGatewayRegion

public String getGatewayRegion()

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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

Constraints:
Length: 1 - 25

Returns:

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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

setGatewayRegion

public void setGatewayRegion(String 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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

Constraints:
Length: 1 - 25

Parameters:

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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

withGatewayRegion

public ActivateGatewayRequest withGatewayRegion(String 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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

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

Constraints:
Length: 1 - 25

Parameters:

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", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

Returns:

A reference to this updated object so that method calls can be chained together.

getGatewayType

public String getGatewayType()

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.

Constraints:
Length: 2 - 20

Returns:

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.

setGatewayType

public void setGatewayType(String 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.

Constraints:
Length: 2 - 20

Parameters:

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.

withGatewayType

public ActivateGatewayRequest withGatewayType(String 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.

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

Constraints:
Length: 2 - 20

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTapeDriveType

public String getTapeDriveType()

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

Valid Values: "IBM-ULT3580-TD5"

Constraints:
Length: 2 - 50

Returns:

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

Valid Values: "IBM-ULT3580-TD5"

setTapeDriveType

public void setTapeDriveType(String tapeDriveType)

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

Valid Values: "IBM-ULT3580-TD5"

Constraints:
Length: 2 - 50

Parameters:

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

Valid Values: "IBM-ULT3580-TD5"

withTapeDriveType

public ActivateGatewayRequest withTapeDriveType(String tapeDriveType)

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

Valid Values: "IBM-ULT3580-TD5"

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

Constraints:
Length: 2 - 50

Parameters:

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

Valid Values: "IBM-ULT3580-TD5"

Returns:

A reference to this updated object so that method calls can be chained together.

getMediumChangerType

public String getMediumChangerType()

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

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

Constraints:
Length: 2 - 50

Returns:

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

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

setMediumChangerType

public void setMediumChangerType(String mediumChangerType)

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

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

Constraints:
Length: 2 - 50

Parameters:

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

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

withMediumChangerType

public ActivateGatewayRequest withMediumChangerType(String mediumChangerType)

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

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

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

Constraints:
Length: 2 - 50

Parameters:

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ActivateGatewayRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()