Amazonka.SSM.Types.DocumentIdentifier

Documentation

data DocumentIdentifier

Describes the name of a SSM document.

See: newDocumentIdentifier smart constructor.

Constructors

DocumentIdentifier'

Fields

• author :: Maybe Text

  The user in your organization who created the document.

• createdDate :: Maybe POSIX

  The date the SSM document was created.

• 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. If you want to update this value, see UpdateDocument.

• documentFormat :: Maybe DocumentFormat

  The document format, either JSON or YAML.

• documentType :: Maybe DocumentType

  The document type.

• documentVersion :: Maybe Text

  The document version.

• name :: Maybe Text

  The name of the SSM document.

• owner :: Maybe Text

  The Amazon Web Services user account that created the document.

• platformTypes :: Maybe [PlatformType]

  The operating system platform.

• requires :: Maybe (NonEmpty DocumentRequires)

  A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

• reviewStatus :: Maybe ReviewStatus

  The current status of a document review.

• schemaVersion :: Maybe Text

  The schema version.

• tags :: Maybe [Tag]

  The tags, or metadata, that have been applied to the document.

• targetType :: Maybe Text

  The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. 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 associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

Instances

FromJSON DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

parseJSON :: Value -> Parser DocumentIdentifier

parseJSONList :: Value -> Parser [DocumentIdentifier]

Generic DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Associated Types

type Rep DocumentIdentifier :: Type -> Type

Methods

from :: DocumentIdentifier -> Rep DocumentIdentifier x

to :: Rep DocumentIdentifier x -> DocumentIdentifier

Read DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

readsPrec :: Int -> ReadS DocumentIdentifier

readList :: ReadS [DocumentIdentifier]

readPrec :: ReadPrec DocumentIdentifier

readListPrec :: ReadPrec [DocumentIdentifier]

Show DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

showsPrec :: Int -> DocumentIdentifier -> ShowS

show :: DocumentIdentifier -> String

showList :: [DocumentIdentifier] -> ShowS

NFData DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

rnf :: DocumentIdentifier -> ()

Eq DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

(==) :: DocumentIdentifier -> DocumentIdentifier -> Bool

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

Hashable DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

Methods

hashWithSalt :: Int -> DocumentIdentifier -> Int

hash :: DocumentIdentifier -> Int

type Rep DocumentIdentifier

Defined in Amazonka.SSM.Types.DocumentIdentifier

type Rep DocumentIdentifier = D1 ('MetaData "DocumentIdentifier" "Amazonka.SSM.Types.DocumentIdentifier" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DocumentIdentifier'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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 "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platformTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformType]))) :*: (S1 ('MetaSel ('Just "requires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentRequires))) :*: S1 ('MetaSel ('Just "reviewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewStatus)))) :*: ((S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)))))))

newDocumentIdentifier :: DocumentIdentifier

Create a value of DocumentIdentifier 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:author:DocumentIdentifier', documentIdentifier_author - The user in your organization who created the document.

$sel:createdDate:DocumentIdentifier', documentIdentifier_createdDate - The date the SSM document was created.

$sel:displayName:DocumentIdentifier', documentIdentifier_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. If you want to update this value, see UpdateDocument.

$sel:documentFormat:DocumentIdentifier', documentIdentifier_documentFormat - The document format, either JSON or YAML.

$sel:documentType:DocumentIdentifier', documentIdentifier_documentType - The document type.

$sel:documentVersion:DocumentIdentifier', documentIdentifier_documentVersion - The document version.

DocumentIdentifier, documentIdentifier_name - The name of the SSM document.

$sel:owner:DocumentIdentifier', documentIdentifier_owner - The Amazon Web Services user account that created the document.

$sel:platformTypes:DocumentIdentifier', documentIdentifier_platformTypes - The operating system platform.

$sel:requires:DocumentIdentifier', documentIdentifier_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

$sel:reviewStatus:DocumentIdentifier', documentIdentifier_reviewStatus - The current status of a document review.

$sel:schemaVersion:DocumentIdentifier', documentIdentifier_schemaVersion - The schema version.

$sel:tags:DocumentIdentifier', documentIdentifier_tags - The tags, or metadata, that have been applied to the document.

$sel:targetType:DocumentIdentifier', documentIdentifier_targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

DocumentIdentifier, documentIdentifier_versionName - An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

documentIdentifier_author :: Lens' DocumentIdentifier (Maybe Text)

The user in your organization who created the document.

documentIdentifier_createdDate :: Lens' DocumentIdentifier (Maybe UTCTime)

The date the SSM document was created.

documentIdentifier_displayName :: Lens' DocumentIdentifier (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. If you want to update this value, see UpdateDocument.

documentIdentifier_documentFormat :: Lens' DocumentIdentifier (Maybe DocumentFormat)

The document format, either JSON or YAML.

documentIdentifier_documentType :: Lens' DocumentIdentifier (Maybe DocumentType)

The document type.

documentIdentifier_documentVersion :: Lens' DocumentIdentifier (Maybe Text)

The document version.

documentIdentifier_name :: Lens' DocumentIdentifier (Maybe Text)

The name of the SSM document.

documentIdentifier_owner :: Lens' DocumentIdentifier (Maybe Text)

The Amazon Web Services user account that created the document.

documentIdentifier_platformTypes :: Lens' DocumentIdentifier (Maybe [PlatformType])

The operating system platform.

documentIdentifier_requires :: Lens' DocumentIdentifier (Maybe (NonEmpty DocumentRequires))

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

documentIdentifier_reviewStatus :: Lens' DocumentIdentifier (Maybe ReviewStatus)

The current status of a document review.

documentIdentifier_schemaVersion :: Lens' DocumentIdentifier (Maybe Text)

The schema version.

documentIdentifier_tags :: Lens' DocumentIdentifier (Maybe [Tag])

The tags, or metadata, that have been applied to the document.

documentIdentifier_targetType :: Lens' DocumentIdentifier (Maybe Text)

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

documentIdentifier_versionName :: Lens' DocumentIdentifier (Maybe Text)

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.