Amazonka.Config.Types.TemplateSSMDocumentDetails

Documentation

data TemplateSSMDocumentDetails

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API. You can also provide the DocumentVersion.

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

See: newTemplateSSMDocumentDetails smart constructor.

Constructors

TemplateSSMDocumentDetails'

Fields

• documentVersion :: Maybe Text

  The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

  This field is optional.

• documentName :: Text

  The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

Instances

FromJSON TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

parseJSON :: Value -> Parser TemplateSSMDocumentDetails

parseJSONList :: Value -> Parser [TemplateSSMDocumentDetails]

ToJSON TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

toJSON :: TemplateSSMDocumentDetails -> Value

toEncoding :: TemplateSSMDocumentDetails -> Encoding

toJSONList :: [TemplateSSMDocumentDetails] -> Value

toEncodingList :: [TemplateSSMDocumentDetails] -> Encoding

Generic TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Associated Types

type Rep TemplateSSMDocumentDetails :: Type -> Type

Methods

from :: TemplateSSMDocumentDetails -> Rep TemplateSSMDocumentDetails x

to :: Rep TemplateSSMDocumentDetails x -> TemplateSSMDocumentDetails

Read TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

readsPrec :: Int -> ReadS TemplateSSMDocumentDetails

readList :: ReadS [TemplateSSMDocumentDetails]

readPrec :: ReadPrec TemplateSSMDocumentDetails

readListPrec :: ReadPrec [TemplateSSMDocumentDetails]

Show TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

showsPrec :: Int -> TemplateSSMDocumentDetails -> ShowS

show :: TemplateSSMDocumentDetails -> String

showList :: [TemplateSSMDocumentDetails] -> ShowS

NFData TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

rnf :: TemplateSSMDocumentDetails -> ()

Eq TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

(==) :: TemplateSSMDocumentDetails -> TemplateSSMDocumentDetails -> Bool

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

Hashable TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

Methods

hashWithSalt :: Int -> TemplateSSMDocumentDetails -> Int

hash :: TemplateSSMDocumentDetails -> Int

type Rep TemplateSSMDocumentDetails

Defined in Amazonka.Config.Types.TemplateSSMDocumentDetails

type Rep TemplateSSMDocumentDetails = D1 ('MetaData "TemplateSSMDocumentDetails" "Amazonka.Config.Types.TemplateSSMDocumentDetails" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "TemplateSSMDocumentDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTemplateSSMDocumentDetails

Arguments

:: Text

$sel:documentName:TemplateSSMDocumentDetails'

-> TemplateSSMDocumentDetails

Create a value of TemplateSSMDocumentDetails 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:documentVersion:TemplateSSMDocumentDetails', templateSSMDocumentDetails_documentVersion - The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

This field is optional.

$sel:documentName:TemplateSSMDocumentDetails', templateSSMDocumentDetails_documentName - The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

templateSSMDocumentDetails_documentVersion :: Lens' TemplateSSMDocumentDetails (Maybe Text)

The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

This field is optional.

templateSSMDocumentDetails_documentName :: Lens' TemplateSSMDocumentDetails Text

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.