Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SSM.CreateAssociation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Creating a Request

createAssociation #

Arguments

:: Text	`caName`
-> CreateAssociation

Creates a value of CreateAssociation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

caInstanceId - The instance ID.
caScheduleExpression - A cron expression when the association will be applied to the target(s).
caOutputLocation - An Amazon S3 bucket where you want to store the output details of the request.
caTargets - The targets (either instances or tags) for the association.
caParameters - The parameters for the documents runtime configuration.
caDocumentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.
caAssociationName - Specify a descriptive name for the association.
caName - The name of the Systems Manager document.

data CreateAssociation #

See: createAssociation smart constructor.

Instances

Eq CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods (==) :: CreateAssociation -> CreateAssociation -> Bool # (/=) :: CreateAssociation -> CreateAssociation -> Bool #
Data CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAssociation -> c CreateAssociation # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAssociation # toConstr :: CreateAssociation -> Constr # dataTypeOf :: CreateAssociation -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateAssociation) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAssociation) # gmapT :: (forall b. Data b => b -> b) -> CreateAssociation -> CreateAssociation # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAssociation -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAssociation -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateAssociation -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAssociation -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAssociation -> m CreateAssociation # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAssociation -> m CreateAssociation # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAssociation -> m CreateAssociation #
Read CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods readsPrec :: Int -> ReadS CreateAssociation # readList :: ReadS [CreateAssociation] # readPrec :: ReadPrec CreateAssociation # readListPrec :: ReadPrec [CreateAssociation] #
Show CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods showsPrec :: Int -> CreateAssociation -> ShowS # show :: CreateAssociation -> String # showList :: [CreateAssociation] -> ShowS #
Generic CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Associated Types type Rep CreateAssociation :: * -> * # Methods from :: CreateAssociation -> Rep CreateAssociation x # to :: Rep CreateAssociation x -> CreateAssociation #
Hashable CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods hashWithSalt :: Int -> CreateAssociation -> Int # hash :: CreateAssociation -> Int #
ToJSON CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods toJSON :: CreateAssociation -> Value # toEncoding :: CreateAssociation -> Encoding # toJSONList :: [CreateAssociation] -> Value # toEncodingList :: [CreateAssociation] -> Encoding #
AWSRequest CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Associated Types type Rs CreateAssociation :: * # Methods request :: CreateAssociation -> Request CreateAssociation # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateAssociation -> ClientResponse -> m (Response CreateAssociation) #
ToHeaders CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods toHeaders :: CreateAssociation -> [Header] #
ToPath CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods toPath :: CreateAssociation -> ByteString #
ToQuery CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods toQuery :: CreateAssociation -> QueryString #
NFData CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods rnf :: CreateAssociation -> () #
type Rep CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation type Rep CreateAssociation = D1 (MetaData "CreateAssociation" "Network.AWS.SSM.CreateAssociation" "amazonka-ssm-1.6.0-2O4V6sSpPonKM5mzsQDhXT" False) (C1 (MetaCons "CreateAssociation'" PrefixI True) (((S1 (MetaSel (Just "_caInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_caScheduleExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_caOutputLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InstanceAssociationOutputLocation)) :: S1 (MetaSel (Just "_caTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Target])))) :: ((S1 (MetaSel (Just "_caParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text]))) :: S1 (MetaSel (Just "_caDocumentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_caAssociationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_caName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateAssociation #
Instance details Defined in Network.AWS.SSM.CreateAssociation type Rs CreateAssociation = CreateAssociationResponse

Request Lenses

caInstanceId :: Lens' CreateAssociation (Maybe Text) #

The instance ID.

caScheduleExpression :: Lens' CreateAssociation (Maybe Text) #

A cron expression when the association will be applied to the target(s).

caOutputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation) #

An Amazon S3 bucket where you want to store the output details of the request.

caTargets :: Lens' CreateAssociation [Target] #

The targets (either instances or tags) for the association.

caParameters :: Lens' CreateAssociation (HashMap Text [Text]) #

The parameters for the documents runtime configuration.

caDocumentVersion :: Lens' CreateAssociation (Maybe Text) #

The document version you want to associate with the target(s). Can be a specific version or the default version.

caAssociationName :: Lens' CreateAssociation (Maybe Text) #

Specify a descriptive name for the association.

caName :: Lens' CreateAssociation Text #

The name of the Systems Manager document.

Destructuring the Response

createAssociationResponse #

Arguments

:: Int	`crsResponseStatus`
-> CreateAssociationResponse

Creates a value of CreateAssociationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

crsAssociationDescription - Information about the association.
crsResponseStatus - -- | The response status code.

data CreateAssociationResponse #

See: createAssociationResponse smart constructor.

Instances

Eq CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods (==) :: CreateAssociationResponse -> CreateAssociationResponse -> Bool # (/=) :: CreateAssociationResponse -> CreateAssociationResponse -> Bool #
Data CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAssociationResponse -> c CreateAssociationResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAssociationResponse # toConstr :: CreateAssociationResponse -> Constr # dataTypeOf :: CreateAssociationResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateAssociationResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAssociationResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateAssociationResponse -> CreateAssociationResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAssociationResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAssociationResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateAssociationResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAssociationResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAssociationResponse -> m CreateAssociationResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAssociationResponse -> m CreateAssociationResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAssociationResponse -> m CreateAssociationResponse #
Read CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods readsPrec :: Int -> ReadS CreateAssociationResponse # readList :: ReadS [CreateAssociationResponse] # readPrec :: ReadPrec CreateAssociationResponse # readListPrec :: ReadPrec [CreateAssociationResponse] #
Show CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods showsPrec :: Int -> CreateAssociationResponse -> ShowS # show :: CreateAssociationResponse -> String # showList :: [CreateAssociationResponse] -> ShowS #
Generic CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Associated Types type Rep CreateAssociationResponse :: * -> * # Methods from :: CreateAssociationResponse -> Rep CreateAssociationResponse x # to :: Rep CreateAssociationResponse x -> CreateAssociationResponse #
NFData CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation Methods rnf :: CreateAssociationResponse -> () #
type Rep CreateAssociationResponse #
Instance details Defined in Network.AWS.SSM.CreateAssociation type Rep CreateAssociationResponse = D1 (MetaData "CreateAssociationResponse" "Network.AWS.SSM.CreateAssociation" "amazonka-ssm-1.6.0-2O4V6sSpPonKM5mzsQDhXT" False) (C1 (MetaCons "CreateAssociationResponse'" PrefixI True) (S1 (MetaSel (Just "_crsAssociationDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AssociationDescription)) :*: S1 (MetaSel (Just "_crsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

crsAssociationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription) #

Information about the association.

crsResponseStatus :: Lens' CreateAssociationResponse Int #

- | The response status code.