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 |
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.
Synopsis
- createAssociation :: Text -> CreateAssociation
- data CreateAssociation
- caInstanceId :: Lens' CreateAssociation (Maybe Text)
- caScheduleExpression :: Lens' CreateAssociation (Maybe Text)
- caOutputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation)
- caTargets :: Lens' CreateAssociation [Target]
- caParameters :: Lens' CreateAssociation (HashMap Text [Text])
- caDocumentVersion :: Lens' CreateAssociation (Maybe Text)
- caAssociationName :: Lens' CreateAssociation (Maybe Text)
- caName :: Lens' CreateAssociation Text
- createAssociationResponse :: Int -> CreateAssociationResponse
- data CreateAssociationResponse
- crsAssociationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription)
- crsResponseStatus :: Lens' CreateAssociationResponse Int
Creating a Request
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 Source #
See: createAssociation
smart constructor.
Instances
Request Lenses
caInstanceId :: Lens' CreateAssociation (Maybe Text) Source #
The instance ID.
caScheduleExpression :: Lens' CreateAssociation (Maybe Text) Source #
A cron expression when the association will be applied to the target(s).
caOutputLocation :: Lens' CreateAssociation (Maybe InstanceAssociationOutputLocation) Source #
An Amazon S3 bucket where you want to store the output details of the request.
caTargets :: Lens' CreateAssociation [Target] Source #
The targets (either instances or tags) for the association.
caParameters :: Lens' CreateAssociation (HashMap Text [Text]) Source #
The parameters for the documents runtime configuration.
caDocumentVersion :: Lens' CreateAssociation (Maybe Text) Source #
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) Source #
Specify a descriptive name for the association.
Destructuring the Response
createAssociationResponse Source #
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 Source #
See: createAssociationResponse
smart constructor.
Instances
Response Lenses
crsAssociationDescription :: Lens' CreateAssociationResponse (Maybe AssociationDescription) Source #
Information about the association.
crsResponseStatus :: Lens' CreateAssociationResponse Int Source #
- - | The response status code.