CreateAppCookieStickinessPolicy.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.ELB.CreateAppCookieStickinessPolicy
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)

-- | Generates a stickiness policy with sticky session lifetimes that follow that
-- of an application-generated cookie. This policy can be associated only with
-- HTTP/HTTPS listeners.
--
-- This policy is similar to the policy created by 'CreateLBCookieStickinessPolicy', except that the lifetime of the special Elastic Load Balancing cookie
-- follows the lifetime of the application-generated cookie specified in the
-- policy configuration. The load balancer only inserts a new stickiness cookie
-- when the application response includes a new application cookie.
--
-- If the application cookie is explicitly removed or expires, the session
-- stops being sticky until a new application cookie is issued.
--
-- An application client must receive and send two cookies: the
-- application-generated cookie and the special Elastic Load Balancing cookie
-- named 'AWSELB'. This is the default behavior for many common web browsers.  For
-- more information, see <http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies Enabling Application-Controlled Session Stickiness> in
-- the /Elastic Load Balancing Developer Guide/.
--
-- <http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_CreateAppCookieStickinessPolicy.html>
module Network.AWS.ELB.CreateAppCookieStickinessPolicy
    (
    -- * Request
      CreateAppCookieStickinessPolicy
    -- ** Request constructor
    , createAppCookieStickinessPolicy
    -- ** Request lenses
    , cacspCookieName
    , cacspLoadBalancerName
    , cacspPolicyName

    -- * Response
    , CreateAppCookieStickinessPolicyResponse
    -- ** Response constructor
    , createAppCookieStickinessPolicyResponse
    ) where

import Network.AWS.Prelude
import Network.AWS.Request.Query
import Network.AWS.ELB.Types
import qualified GHC.Exts

data CreateAppCookieStickinessPolicy = CreateAppCookieStickinessPolicy
    { _cacspCookieName       :: Text
    , _cacspLoadBalancerName :: Text
    , _cacspPolicyName       :: Text
    } deriving (Eq, Ord, Show)

-- | 'CreateAppCookieStickinessPolicy' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'cacspCookieName' @::@ 'Text'
--
-- * 'cacspLoadBalancerName' @::@ 'Text'
--
-- * 'cacspPolicyName' @::@ 'Text'
--
createAppCookieStickinessPolicy :: Text -- ^ 'cacspLoadBalancerName'
                                -> Text -- ^ 'cacspPolicyName'
                                -> Text -- ^ 'cacspCookieName'
                                -> CreateAppCookieStickinessPolicy
createAppCookieStickinessPolicy p1 p2 p3 = CreateAppCookieStickinessPolicy
    { _cacspLoadBalancerName = p1
    , _cacspPolicyName       = p2
    , _cacspCookieName       = p3
    }

-- | Name of the application cookie used for stickiness.
cacspCookieName :: Lens' CreateAppCookieStickinessPolicy Text
cacspCookieName = lens _cacspCookieName (\s a -> s { _cacspCookieName = a })

-- | The name of the load balancer.
cacspLoadBalancerName :: Lens' CreateAppCookieStickinessPolicy Text
cacspLoadBalancerName =
    lens _cacspLoadBalancerName (\s a -> s { _cacspLoadBalancerName = a })

-- | The name of the policy being created. The name must be unique within the set
-- of policies for this load balancer.
cacspPolicyName :: Lens' CreateAppCookieStickinessPolicy Text
cacspPolicyName = lens _cacspPolicyName (\s a -> s { _cacspPolicyName = a })

data CreateAppCookieStickinessPolicyResponse = CreateAppCookieStickinessPolicyResponse
    deriving (Eq, Ord, Show, Generic)

-- | 'CreateAppCookieStickinessPolicyResponse' constructor.
createAppCookieStickinessPolicyResponse :: CreateAppCookieStickinessPolicyResponse
createAppCookieStickinessPolicyResponse = CreateAppCookieStickinessPolicyResponse

instance ToPath CreateAppCookieStickinessPolicy where
    toPath = const "/"

instance ToQuery CreateAppCookieStickinessPolicy where
    toQuery CreateAppCookieStickinessPolicy{..} = mconcat
        [ "CookieName"       =? _cacspCookieName
        , "LoadBalancerName" =? _cacspLoadBalancerName
        , "PolicyName"       =? _cacspPolicyName
        ]

instance ToHeaders CreateAppCookieStickinessPolicy

instance AWSRequest CreateAppCookieStickinessPolicy where
    type Sv CreateAppCookieStickinessPolicy = ELB
    type Rs CreateAppCookieStickinessPolicy = CreateAppCookieStickinessPolicyResponse

    request  = post "CreateAppCookieStickinessPolicy"
    response = nullResponse CreateAppCookieStickinessPolicyResponse