{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.StorageGateway.ActivateGateway -- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, 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' . -- -- module Network.AWS.StorageGateway.ActivateGateway ( -- * Creating a Request activateGateway , ActivateGateway -- * Request Lenses , agMediumChangerType , agTapeDriveType , agGatewayType , agActivationKey , agGatewayName , agGatewayTimezone , agGatewayRegion -- * Destructuring the Response , activateGatewayResponse , ActivateGatewayResponse -- * Response Lenses , agrsGatewayARN , agrsResponseStatus ) where import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response import Network.AWS.StorageGateway.Types import Network.AWS.StorageGateway.Types.Product -- | A JSON object containing one or more of the following fields: -- -- -- * 'ActivateGatewayInput$ActivationKey' -- -- * 'ActivateGatewayInput$GatewayName' -- -- * 'ActivateGatewayInput$GatewayRegion' -- -- * 'ActivateGatewayInput$GatewayTimezone' -- -- * 'ActivateGatewayInput$GatewayType' -- -- * 'ActivateGatewayInput$TapeDriveType' -- -- * 'ActivateGatewayInput$MediumChangerType' -- -- -- -- -- /See:/ 'activateGateway' smart constructor. data ActivateGateway = ActivateGateway' { _agMediumChangerType :: !(Maybe Text) , _agTapeDriveType :: !(Maybe Text) , _agGatewayType :: !(Maybe Text) , _agActivationKey :: !Text , _agGatewayName :: !Text , _agGatewayTimezone :: !Text , _agGatewayRegion :: !Text } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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: -- -- * 'agMediumChangerType' - 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" -- -- * 'agTapeDriveType' - The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5" -- -- * 'agGatewayType' - 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 @STORED@ . Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" -- -- * 'agActivationKey' - 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. -- -- * 'agGatewayName' - The name you configured for your gateway. -- -- * 'agGatewayTimezone' - 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. -- -- * 'agGatewayRegion' - 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 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" activateGateway :: Text -- ^ 'agActivationKey' -> Text -- ^ 'agGatewayName' -> Text -- ^ 'agGatewayTimezone' -> Text -- ^ 'agGatewayRegion' -> ActivateGateway activateGateway pActivationKey_ pGatewayName_ pGatewayTimezone_ pGatewayRegion_ = ActivateGateway' { _agMediumChangerType = Nothing , _agTapeDriveType = Nothing , _agGatewayType = Nothing , _agActivationKey = pActivationKey_ , _agGatewayName = pGatewayName_ , _agGatewayTimezone = pGatewayTimezone_ , _agGatewayRegion = pGatewayRegion_ } -- | 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" agMediumChangerType :: Lens' ActivateGateway (Maybe Text) agMediumChangerType = lens _agMediumChangerType (\ s a -> s{_agMediumChangerType = a}) -- | The value that indicates the type of tape drive to use for tape gateway. This field is optional. Valid Values: "IBM-ULT3580-TD5" agTapeDriveType :: Lens' ActivateGateway (Maybe Text) agTapeDriveType = lens _agTapeDriveType (\ s a -> s{_agTapeDriveType = a}) -- | 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 @STORED@ . Valid Values: "STORED", "CACHED", "VTL", "FILE_S3" agGatewayType :: Lens' ActivateGateway (Maybe Text) agGatewayType = lens _agGatewayType (\ s a -> s{_agGatewayType = a}) -- | 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. agActivationKey :: Lens' ActivateGateway Text agActivationKey = lens _agActivationKey (\ s a -> s{_agActivationKey = a}) -- | The name you configured for your gateway. agGatewayName :: Lens' ActivateGateway Text agGatewayName = lens _agGatewayName (\ s a -> s{_agGatewayName = a}) -- | 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. agGatewayTimezone :: Lens' ActivateGateway Text agGatewayTimezone = lens _agGatewayTimezone (\ s a -> s{_agGatewayTimezone = a}) -- | 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 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" agGatewayRegion :: Lens' ActivateGateway Text agGatewayRegion = lens _agGatewayRegion (\ s a -> s{_agGatewayRegion = a}) instance AWSRequest ActivateGateway where type Rs ActivateGateway = ActivateGatewayResponse request = postJSON storageGateway response = receiveJSON (\ s h x -> ActivateGatewayResponse' <$> (x .?> "GatewayARN") <*> (pure (fromEnum s))) instance Hashable ActivateGateway where instance NFData ActivateGateway where instance ToHeaders ActivateGateway where toHeaders = const (mconcat ["X-Amz-Target" =# ("StorageGateway_20130630.ActivateGateway" :: ByteString), "Content-Type" =# ("application/x-amz-json-1.1" :: ByteString)]) instance ToJSON ActivateGateway where toJSON ActivateGateway'{..} = object (catMaybes [("MediumChangerType" .=) <$> _agMediumChangerType, ("TapeDriveType" .=) <$> _agTapeDriveType, ("GatewayType" .=) <$> _agGatewayType, Just ("ActivationKey" .= _agActivationKey), Just ("GatewayName" .= _agGatewayName), Just ("GatewayTimezone" .= _agGatewayTimezone), Just ("GatewayRegion" .= _agGatewayRegion)]) instance ToPath ActivateGateway where toPath = const "/" instance ToQuery ActivateGateway where toQuery = const mempty -- | 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. data ActivateGatewayResponse = ActivateGatewayResponse' { _agrsGatewayARN :: !(Maybe Text) , _agrsResponseStatus :: !Int } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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: -- -- * 'agrsGatewayARN' - Undocumented member. -- -- * 'agrsResponseStatus' - -- | The response status code. activateGatewayResponse :: Int -- ^ 'agrsResponseStatus' -> ActivateGatewayResponse activateGatewayResponse pResponseStatus_ = ActivateGatewayResponse' {_agrsGatewayARN = Nothing, _agrsResponseStatus = pResponseStatus_} -- | Undocumented member. agrsGatewayARN :: Lens' ActivateGatewayResponse (Maybe Text) agrsGatewayARN = lens _agrsGatewayARN (\ s a -> s{_agrsGatewayARN = a}) -- | -- | The response status code. agrsResponseStatus :: Lens' ActivateGatewayResponse Int agrsResponseStatus = lens _agrsResponseStatus (\ s a -> s{_agrsResponseStatus = a}) instance NFData ActivateGatewayResponse where