Network.AWS.SSM.CreateDocument

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Creating a Request

createDocument

Arguments

:: Text

cdContent

-> Text

cdName

-> CreateDocument

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

See: createDocument smart constructor.

Instances

Eq CreateDocument

Methods

(==) :: CreateDocument -> CreateDocument -> Bool

(/=) :: CreateDocument -> CreateDocument -> Bool

Data CreateDocument

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDocument -> c CreateDocument

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDocument

toConstr :: CreateDocument -> Constr

dataTypeOf :: CreateDocument -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDocument)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDocument)

gmapT :: (forall b. Data b => b -> b) -> CreateDocument -> CreateDocument

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDocument -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDocument -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDocument -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDocument -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDocument -> m CreateDocument

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDocument -> m CreateDocument

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDocument -> m CreateDocument

Read CreateDocument

Methods

readsPrec :: Int -> ReadS CreateDocument

readList :: ReadS [CreateDocument]

readPrec :: ReadPrec CreateDocument

readListPrec :: ReadPrec [CreateDocument]

Show CreateDocument

Methods

showsPrec :: Int -> CreateDocument -> ShowS

show :: CreateDocument -> String

showList :: [CreateDocument] -> ShowS

Generic CreateDocument

Associated Types

type Rep CreateDocument :: * -> *

Methods

from :: CreateDocument -> Rep CreateDocument x

to :: Rep CreateDocument x -> CreateDocument

Hashable CreateDocument

Methods

hashWithSalt :: Int -> CreateDocument -> Int

hash :: CreateDocument -> Int

ToJSON CreateDocument

Methods

toJSON :: CreateDocument -> Value

toEncoding :: CreateDocument -> Encoding

toJSONList :: [CreateDocument] -> Value

toEncodingList :: [CreateDocument] -> Encoding

NFData CreateDocument

Methods

rnf :: CreateDocument -> ()

AWSRequest CreateDocument

Associated Types

type Rs CreateDocument :: *

Methods

request :: CreateDocument -> Request CreateDocument

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateDocument -> ClientResponse -> m (Response CreateDocument)

ToHeaders CreateDocument

Methods

toHeaders :: CreateDocument -> [Header]

ToPath CreateDocument

Methods

toPath :: CreateDocument -> ByteString

ToQuery CreateDocument

Methods

toQuery :: CreateDocument -> QueryString

type Rep CreateDocument

type Rep CreateDocument = D1 * (MetaData "CreateDocument" "Network.AWS.SSM.CreateDocument" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "CreateDocument'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdDocumentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DocumentType))) (S1 * (MetaSel (Just Symbol "_cdTargetType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdDocumentFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DocumentFormat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateDocument

type Rs CreateDocument = CreateDocumentResponse

Request Lenses

cdDocumentType :: Lens' CreateDocument (Maybe DocumentType)

The type of document to create. Valid document types include: Policy, Automation, and Command.

cdTargetType :: Lens' CreateDocument (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 AWS Resource Types Reference in the AWS CloudFormation User Guide .

cdDocumentFormat :: Lens' CreateDocument (Maybe DocumentFormat)

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

cdContent :: Lens' CreateDocument Text

A valid JSON or YAML string.

cdName :: Lens' CreateDocument Text

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

Arguments

:: Int

cdrsResponseStatus

-> CreateDocumentResponse

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

See: createDocumentResponse smart constructor.

Instances

Eq CreateDocumentResponse

Methods

(==) :: CreateDocumentResponse -> CreateDocumentResponse -> Bool

(/=) :: CreateDocumentResponse -> CreateDocumentResponse -> Bool

Data CreateDocumentResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDocumentResponse -> c CreateDocumentResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDocumentResponse

toConstr :: CreateDocumentResponse -> Constr

dataTypeOf :: CreateDocumentResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDocumentResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDocumentResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateDocumentResponse -> CreateDocumentResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDocumentResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDocumentResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDocumentResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDocumentResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDocumentResponse -> m CreateDocumentResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDocumentResponse -> m CreateDocumentResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDocumentResponse -> m CreateDocumentResponse

Read CreateDocumentResponse

Methods

readsPrec :: Int -> ReadS CreateDocumentResponse

readList :: ReadS [CreateDocumentResponse]

readPrec :: ReadPrec CreateDocumentResponse

readListPrec :: ReadPrec [CreateDocumentResponse]

Show CreateDocumentResponse

Methods

showsPrec :: Int -> CreateDocumentResponse -> ShowS

show :: CreateDocumentResponse -> String

showList :: [CreateDocumentResponse] -> ShowS

Generic CreateDocumentResponse

Associated Types

type Rep CreateDocumentResponse :: * -> *

Methods

from :: CreateDocumentResponse -> Rep CreateDocumentResponse x

to :: Rep CreateDocumentResponse x -> CreateDocumentResponse

NFData CreateDocumentResponse

Methods

rnf :: CreateDocumentResponse -> ()

type Rep CreateDocumentResponse

type Rep CreateDocumentResponse = D1 * (MetaData "CreateDocumentResponse" "Network.AWS.SSM.CreateDocument" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "CreateDocumentResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdrsDocumentDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DocumentDescription))) (S1 * (MetaSel (Just Symbol "_cdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cdrsDocumentDescription :: Lens' CreateDocumentResponse (Maybe DocumentDescription)

Information about the Systems Manager document.

cdrsResponseStatus :: Lens' CreateDocumentResponse Int

• - | The response status code.