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 |
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
Synopsis
- createDocument :: Text -> Text -> CreateDocument
- data CreateDocument
- cdDocumentType :: Lens' CreateDocument (Maybe DocumentType)
- cdTargetType :: Lens' CreateDocument (Maybe Text)
- cdDocumentFormat :: Lens' CreateDocument (Maybe DocumentFormat)
- cdContent :: Lens' CreateDocument Text
- cdName :: Lens' CreateDocument Text
- createDocumentResponse :: Int -> CreateDocumentResponse
- data CreateDocumentResponse
- cdrsDocumentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription)
- cdrsResponseStatus :: Lens' CreateDocumentResponse Int
Creating a Request
Creates a value of CreateDocument
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdDocumentType
- The type of document to create. Valid document types include: Policy, Automation, and Command.cdTargetType
- Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: AWS::EC2::Instance. If you specify a value of '' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide .cdDocumentFormat
- Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.cdContent
- A valid JSON or YAML string.cdName
- A name for the Systems Manager document. Important: Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: *aws
*amazon
*amzn
data CreateDocument Source #
See: createDocument
smart constructor.
Instances
Request Lenses
cdDocumentType :: Lens' CreateDocument (Maybe DocumentType) Source #
The type of document to create. Valid document types include: Policy, Automation, and Command.
cdTargetType :: Lens' CreateDocument (Maybe Text) Source #
Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: AWS::EC2::Instance. If you specify a value of '' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide .
cdDocumentFormat :: Lens' CreateDocument (Maybe DocumentFormat) Source #
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
cdName :: Lens' CreateDocument Text Source #
A name for the Systems Manager document. Important: Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes: * aws
* amazon
* amzn
Destructuring the Response
createDocumentResponse Source #
Creates a value of CreateDocumentResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdrsDocumentDescription
- Information about the Systems Manager document.cdrsResponseStatus
- -- | The response status code.
data CreateDocumentResponse Source #
See: createDocumentResponse
smart constructor.
Instances
Response Lenses
cdrsDocumentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription) Source #
Information about the Systems Manager document.
cdrsResponseStatus :: Lens' CreateDocumentResponse Int Source #
- - | The response status code.