amazonka-ecs-1.2.0: gen/Network/AWS/ECS/RegisterContainerInstance.hs
{-# 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.ECS.RegisterContainerInstance
-- 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)
--
-- This action is only used by the Amazon EC2 Container Service agent, and
-- it is not intended for use outside of the agent.
--
-- Registers an Amazon EC2 instance into the specified cluster. This
-- instance will become available to place containers on.
--
-- /See:/ <http://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RegisterContainerInstance.html AWS API Reference> for RegisterContainerInstance.
module Network.AWS.ECS.RegisterContainerInstance
(
-- * Creating a Request
registerContainerInstance
, RegisterContainerInstance
-- * Request Lenses
, rciInstanceIdentityDocumentSignature
, rciCluster
, rciInstanceIdentityDocument
, rciContainerInstanceARN
, rciVersionInfo
, rciTotalResources
-- * Destructuring the Response
, registerContainerInstanceResponse
, RegisterContainerInstanceResponse
-- * Response Lenses
, rcirsContainerInstance
, rcirsStatus
) where
import Network.AWS.ECS.Types
import Network.AWS.ECS.Types.Product
import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
-- | /See:/ 'registerContainerInstance' smart constructor.
data RegisterContainerInstance = RegisterContainerInstance'
{ _rciInstanceIdentityDocumentSignature :: !(Maybe Text)
, _rciCluster :: !(Maybe Text)
, _rciInstanceIdentityDocument :: !(Maybe Text)
, _rciContainerInstanceARN :: !(Maybe Text)
, _rciVersionInfo :: !(Maybe VersionInfo)
, _rciTotalResources :: !(Maybe [Resource])
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'RegisterContainerInstance' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'rciInstanceIdentityDocumentSignature'
--
-- * 'rciCluster'
--
-- * 'rciInstanceIdentityDocument'
--
-- * 'rciContainerInstanceARN'
--
-- * 'rciVersionInfo'
--
-- * 'rciTotalResources'
registerContainerInstance
:: RegisterContainerInstance
registerContainerInstance =
RegisterContainerInstance'
{ _rciInstanceIdentityDocumentSignature = Nothing
, _rciCluster = Nothing
, _rciInstanceIdentityDocument = Nothing
, _rciContainerInstanceARN = Nothing
, _rciVersionInfo = Nothing
, _rciTotalResources = Nothing
}
-- | The instance identity document signature for the Amazon EC2 instance to
-- register. This signature can be found by running the following command
-- from the instance:
-- 'curl http:\/\/169.254.169.254\/latest\/dynamic\/instance-identity\/signature\/'
rciInstanceIdentityDocumentSignature :: Lens' RegisterContainerInstance (Maybe Text)
rciInstanceIdentityDocumentSignature = lens _rciInstanceIdentityDocumentSignature (\ s a -> s{_rciInstanceIdentityDocumentSignature = a});
-- | The short name or full Amazon Resource Name (ARN) of the cluster that
-- you want to register your container instance with. If you do not specify
-- a cluster, the default cluster is assumed..
rciCluster :: Lens' RegisterContainerInstance (Maybe Text)
rciCluster = lens _rciCluster (\ s a -> s{_rciCluster = a});
-- | The instance identity document for the Amazon EC2 instance to register.
-- This document can be found by running the following command from the
-- instance:
-- 'curl http:\/\/169.254.169.254\/latest\/dynamic\/instance-identity\/document\/'
rciInstanceIdentityDocument :: Lens' RegisterContainerInstance (Maybe Text)
rciInstanceIdentityDocument = lens _rciInstanceIdentityDocument (\ s a -> s{_rciInstanceIdentityDocument = a});
-- | The Amazon Resource Name (ARN) of the container instance (if it was
-- previously registered).
rciContainerInstanceARN :: Lens' RegisterContainerInstance (Maybe Text)
rciContainerInstanceARN = lens _rciContainerInstanceARN (\ s a -> s{_rciContainerInstanceARN = a});
-- | The version information for the Amazon ECS container agent and Docker
-- daemon running on the container instance.
rciVersionInfo :: Lens' RegisterContainerInstance (Maybe VersionInfo)
rciVersionInfo = lens _rciVersionInfo (\ s a -> s{_rciVersionInfo = a});
-- | The resources available on the instance.
rciTotalResources :: Lens' RegisterContainerInstance [Resource]
rciTotalResources = lens _rciTotalResources (\ s a -> s{_rciTotalResources = a}) . _Default . _Coerce;
instance AWSRequest RegisterContainerInstance where
type Rs RegisterContainerInstance =
RegisterContainerInstanceResponse
request = postJSON eCS
response
= receiveJSON
(\ s h x ->
RegisterContainerInstanceResponse' <$>
(x .?> "containerInstance") <*> (pure (fromEnum s)))
instance ToHeaders RegisterContainerInstance where
toHeaders
= const
(mconcat
["X-Amz-Target" =#
("AmazonEC2ContainerServiceV20141113.RegisterContainerInstance"
:: ByteString),
"Content-Type" =#
("application/x-amz-json-1.1" :: ByteString)])
instance ToJSON RegisterContainerInstance where
toJSON RegisterContainerInstance'{..}
= object
(catMaybes
[("instanceIdentityDocumentSignature" .=) <$>
_rciInstanceIdentityDocumentSignature,
("cluster" .=) <$> _rciCluster,
("instanceIdentityDocument" .=) <$>
_rciInstanceIdentityDocument,
("containerInstanceArn" .=) <$>
_rciContainerInstanceARN,
("versionInfo" .=) <$> _rciVersionInfo,
("totalResources" .=) <$> _rciTotalResources])
instance ToPath RegisterContainerInstance where
toPath = const "/"
instance ToQuery RegisterContainerInstance where
toQuery = const mempty
-- | /See:/ 'registerContainerInstanceResponse' smart constructor.
data RegisterContainerInstanceResponse = RegisterContainerInstanceResponse'
{ _rcirsContainerInstance :: !(Maybe ContainerInstance)
, _rcirsStatus :: !Int
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'RegisterContainerInstanceResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'rcirsContainerInstance'
--
-- * 'rcirsStatus'
registerContainerInstanceResponse
:: Int -- ^ 'rcirsStatus'
-> RegisterContainerInstanceResponse
registerContainerInstanceResponse pStatus_ =
RegisterContainerInstanceResponse'
{ _rcirsContainerInstance = Nothing
, _rcirsStatus = pStatus_
}
-- | Undocumented member.
rcirsContainerInstance :: Lens' RegisterContainerInstanceResponse (Maybe ContainerInstance)
rcirsContainerInstance = lens _rcirsContainerInstance (\ s a -> s{_rcirsContainerInstance = a});
-- | The response status code.
rcirsStatus :: Lens' RegisterContainerInstanceResponse Int
rcirsStatus = lens _rcirsStatus (\ s a -> s{_rcirsStatus = a});