Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
You must turn on the gateway VM before you can activate your gateway.
See: AWS API Reference for ActivateGateway.
- activateGateway :: Text -> Text -> Text -> Text -> ActivateGateway
- data ActivateGateway
- agMediumChangerType :: Lens' ActivateGateway (Maybe Text)
- agTapeDriveType :: Lens' ActivateGateway (Maybe Text)
- agGatewayType :: Lens' ActivateGateway (Maybe Text)
- agActivationKey :: Lens' ActivateGateway Text
- agGatewayName :: Lens' ActivateGateway Text
- agGatewayTimezone :: Lens' ActivateGateway Text
- agGatewayRegion :: Lens' ActivateGateway Text
- activateGatewayResponse :: Int -> ActivateGatewayResponse
- data ActivateGatewayResponse
- agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text)
- agrsResponseStatus :: Lens' ActivateGatewayResponse Int
Creating a Request
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> ActivateGateway |
Creates a value of ActivateGateway
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ActivateGateway Source
A JSON object containing one or more of the following fields:
- ActivateGatewayInput$ActivationKey
- GatewayName
- ActivateGatewayInput$GatewayRegion
- ActivateGatewayInput$GatewayTimezone
- ActivateGatewayInput$GatewayType
- ActivateGatewayInput$TapeDriveType
- ActivateGatewayInput$MediumChangerType
See: activateGateway
smart constructor.
Request Lenses
agMediumChangerType :: Lens' ActivateGateway (Maybe Text) Source
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"
agTapeDriveType :: Lens' ActivateGateway (Maybe Text) Source
The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.
Valid Values: "IBM-ULT3580-TD5"
agGatewayType :: Lens' ActivateGateway (Maybe Text) Source
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
.
agActivationKey :: Lens' ActivateGateway Text Source
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.
agGatewayName :: Lens' ActivateGateway Text Source
Undocumented member.
agGatewayTimezone :: Lens' ActivateGateway Text Source
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.
agGatewayRegion :: Lens' ActivateGateway Text Source
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"
Destructuring the Response
activateGatewayResponse Source
Creates a value of ActivateGatewayResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ActivateGatewayResponse Source
AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.
See: activateGatewayResponse
smart constructor.
Response Lenses
agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text) Source
Undocumented member.
agrsResponseStatus :: Lens' ActivateGatewayResponse Int Source
The response status code.