Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.CreateDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

Synopsis

data CreateDocument = CreateDocument' {
- attachments :: Maybe [AttachmentsSource]
- displayName :: Maybe Text
- documentFormat :: Maybe DocumentFormat
- documentType :: Maybe DocumentType
- requires :: Maybe (NonEmpty DocumentRequires)
- tags :: Maybe [Tag]
- targetType :: Maybe Text
- versionName :: Maybe Text
- content :: Text
- name :: Text
}
newCreateDocument :: Text -> Text -> CreateDocument
createDocument_attachments :: Lens' CreateDocument (Maybe [AttachmentsSource])
createDocument_displayName :: Lens' CreateDocument (Maybe Text)
createDocument_documentFormat :: Lens' CreateDocument (Maybe DocumentFormat)
createDocument_documentType :: Lens' CreateDocument (Maybe DocumentType)
createDocument_requires :: Lens' CreateDocument (Maybe (NonEmpty DocumentRequires))
createDocument_tags :: Lens' CreateDocument (Maybe [Tag])
createDocument_targetType :: Lens' CreateDocument (Maybe Text)
createDocument_versionName :: Lens' CreateDocument (Maybe Text)
createDocument_content :: Lens' CreateDocument Text
createDocument_name :: Lens' CreateDocument Text
data CreateDocumentResponse = CreateDocumentResponse' {
- documentDescription :: Maybe DocumentDescription
- httpStatus :: Int
}
newCreateDocumentResponse :: Int -> CreateDocumentResponse
createDocumentResponse_documentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription)
createDocumentResponse_httpStatus :: Lens' CreateDocumentResponse Int

Creating a Request

data CreateDocument Source #

See: newCreateDocument smart constructor.

Constructors

CreateDocument'

Fields

attachments :: Maybe [AttachmentsSource]
A list of key-value pairs that describe attachments to a version of a document.
displayName :: Maybe Text
An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.
documentFormat :: Maybe DocumentFormat
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
documentType :: Maybe DocumentType
The type of document to create.
The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.
requires :: Maybe (NonEmpty DocumentRequires)
A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.
tags :: Maybe [Tag]
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:
- ```
Key=OS,Value=Windows
```
- ```
Key=Environment,Value=Production
```
To add tags to an existing SSM document, use the AddTagsToResource operation.
targetType :: Maybe Text
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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.
versionName :: Maybe Text
An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.
content :: Text
The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.
For examples, see the following topics in the /Amazon Web Services Systems Manager User Guide/.
name :: Text
A name for the SSM document.
You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:
- ```
aws
```
- ```
amazon
```
- ```
amzn
```

Instances

Instances details

ToJSON CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods toJSON :: CreateDocument -> Value # toEncoding :: CreateDocument -> Encoding # toJSONList :: [CreateDocument] -> Value # toEncodingList :: [CreateDocument] -> Encoding #
ToHeaders CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods toHeaders :: CreateDocument -> [Header] #
ToPath CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods toPath :: CreateDocument -> ByteString #
ToQuery CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods toQuery :: CreateDocument -> QueryString #
AWSRequest CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Associated Types type AWSResponse CreateDocument # Methods request :: (Service -> Service) -> CreateDocument -> Request CreateDocument # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDocument))) #
Generic CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Associated Types type Rep CreateDocument :: Type -> Type # Methods from :: CreateDocument -> Rep CreateDocument x # to :: Rep CreateDocument x -> CreateDocument #
Read CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods readsPrec :: Int -> ReadS CreateDocument # readList :: ReadS [CreateDocument] # readPrec :: ReadPrec CreateDocument # readListPrec :: ReadPrec [CreateDocument] #
Show CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods showsPrec :: Int -> CreateDocument -> ShowS # show :: CreateDocument -> String # showList :: [CreateDocument] -> ShowS #
NFData CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods rnf :: CreateDocument -> () #
Eq CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods (==) :: CreateDocument -> CreateDocument -> Bool # (/=) :: CreateDocument -> CreateDocument -> Bool #
Hashable CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods hashWithSalt :: Int -> CreateDocument -> Int # hash :: CreateDocument -> Int #
type AWSResponse CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument type AWSResponse CreateDocument = CreateDocumentResponse
type Rep CreateDocument Source #
Instance details Defined in Amazonka.SSM.CreateDocument type Rep CreateDocument = D1 ('MetaData "CreateDocument" "Amazonka.SSM.CreateDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateDocument'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttachmentsSource])) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "documentFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentFormat)) :: (S1 ('MetaSel ('Just "documentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentType)) :: S1 ('MetaSel ('Just "requires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentRequires)))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDocument Source #

Arguments

:: Text	`CreateDocument`
-> Text	`CreateDocument`
-> CreateDocument

Create a value of CreateDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachments:CreateDocument', createDocument_attachments - A list of key-value pairs that describe attachments to a version of a document.

CreateDocument, createDocument_displayName - An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

CreateDocument, createDocument_documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

CreateDocument, createDocument_documentType - The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

CreateDocument, createDocument_requires - A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

CreateDocument, createDocument_tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

```
Key=OS,Value=Windows
```
```
Key=Environment,Value=Production
```

To add tags to an existing SSM document, use the AddTagsToResource operation.

CreateDocument, createDocument_targetType - 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

CreateDocument, createDocument_versionName - An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

CreateDocument, createDocument_content - The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the /Amazon Web Services Systems Manager User Guide/.

CreateDocument, createDocument_name - A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

```
aws
```
```
amazon
```
```
amzn
```

Request Lenses

createDocument_attachments :: Lens' CreateDocument (Maybe [AttachmentsSource]) Source #

A list of key-value pairs that describe attachments to a version of a document.

createDocument_displayName :: Lens' CreateDocument (Maybe Text) Source #

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

createDocument_documentFormat :: Lens' CreateDocument (Maybe DocumentFormat) Source #

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

createDocument_documentType :: Lens' CreateDocument (Maybe DocumentType) Source #

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

createDocument_requires :: Lens' CreateDocument (Maybe (NonEmpty DocumentRequires)) Source #

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

createDocument_tags :: Lens' CreateDocument (Maybe [Tag]) Source #

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

```
Key=OS,Value=Windows
```
```
Key=Environment,Value=Production
```

To add tags to an existing SSM document, use the AddTagsToResource operation.

createDocument_targetType :: 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

createDocument_versionName :: Lens' CreateDocument (Maybe Text) Source #

An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

createDocument_content :: Lens' CreateDocument Text Source #

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the /Amazon Web Services Systems Manager User Guide/.

createDocument_name :: Lens' CreateDocument Text Source #

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

```
aws
```
```
amazon
```
```
amzn
```

Destructuring the Response

data CreateDocumentResponse Source #

See: newCreateDocumentResponse smart constructor.

Constructors

CreateDocumentResponse'
Fields documentDescription :: Maybe DocumentDescription Information about the SSM document. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument Associated Types type Rep CreateDocumentResponse :: Type -> Type # Methods from :: CreateDocumentResponse -> Rep CreateDocumentResponse x # to :: Rep CreateDocumentResponse x -> CreateDocumentResponse #
Read CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods readsPrec :: Int -> ReadS CreateDocumentResponse # readList :: ReadS [CreateDocumentResponse] # readPrec :: ReadPrec CreateDocumentResponse # readListPrec :: ReadPrec [CreateDocumentResponse] #
Show CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods showsPrec :: Int -> CreateDocumentResponse -> ShowS # show :: CreateDocumentResponse -> String # showList :: [CreateDocumentResponse] -> ShowS #
NFData CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods rnf :: CreateDocumentResponse -> () #
Eq CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument Methods (==) :: CreateDocumentResponse -> CreateDocumentResponse -> Bool # (/=) :: CreateDocumentResponse -> CreateDocumentResponse -> Bool #
type Rep CreateDocumentResponse Source #
Instance details Defined in Amazonka.SSM.CreateDocument type Rep CreateDocumentResponse = D1 ('MetaData "CreateDocumentResponse" "Amazonka.SSM.CreateDocument" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateDocumentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDocumentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDocumentResponse'`
-> CreateDocumentResponse

Create a value of CreateDocumentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentDescription:CreateDocumentResponse', createDocumentResponse_documentDescription - Information about the SSM document.

$sel:httpStatus:CreateDocumentResponse', createDocumentResponse_httpStatus - The response's http status code.

Response Lenses

createDocumentResponse_documentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription) Source #

Information about the SSM document.

createDocumentResponse_httpStatus :: Lens' CreateDocumentResponse Int Source #

The response's http status code.