Copyright	(c) 2013-2021 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

Amazonka.SSM.Types.DocumentIdentifier

Description

Synopsis

data DocumentIdentifier = DocumentIdentifier' {
- documentType :: Maybe DocumentType
- versionName :: Maybe Text
- schemaVersion :: Maybe Text
- reviewStatus :: Maybe ReviewStatus
- targetType :: Maybe Text
- owner :: Maybe Text
- platformTypes :: Maybe [PlatformType]
- createdDate :: Maybe POSIX
- documentFormat :: Maybe DocumentFormat
- name :: Maybe Text
- documentVersion :: Maybe Text
- author :: Maybe Text
- displayName :: Maybe Text
- requires :: Maybe (NonEmpty DocumentRequires)
- tags :: Maybe [Tag]
}
newDocumentIdentifier :: DocumentIdentifier
documentIdentifier_documentType :: Lens' DocumentIdentifier (Maybe DocumentType)
documentIdentifier_versionName :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_schemaVersion :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_reviewStatus :: Lens' DocumentIdentifier (Maybe ReviewStatus)
documentIdentifier_targetType :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_owner :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_platformTypes :: Lens' DocumentIdentifier (Maybe [PlatformType])
documentIdentifier_createdDate :: Lens' DocumentIdentifier (Maybe UTCTime)
documentIdentifier_documentFormat :: Lens' DocumentIdentifier (Maybe DocumentFormat)
documentIdentifier_name :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_documentVersion :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_author :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_displayName :: Lens' DocumentIdentifier (Maybe Text)
documentIdentifier_requires :: Lens' DocumentIdentifier (Maybe (NonEmpty DocumentRequires))
documentIdentifier_tags :: Lens' DocumentIdentifier (Maybe [Tag])

Documentation

data DocumentIdentifier Source #

Describes the name of a SSM document.

See: newDocumentIdentifier smart constructor.

Constructors

DocumentIdentifier'

Fields

documentType :: Maybe DocumentType
The document type.
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.
schemaVersion :: Maybe Text
The schema version.
reviewStatus :: Maybe ReviewStatus
The current status of a document review.
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.
owner :: Maybe Text
The Amazon Web Services user account that created the document.
platformTypes :: Maybe [PlatformType]
The operating system platform.
createdDate :: Maybe POSIX
The date the SSM document was created.
documentFormat :: Maybe DocumentFormat
The document format, either JSON or YAML.
name :: Maybe Text
The name of the SSM document.
documentVersion :: Maybe Text
The document version.
author :: Maybe Text
The user in your organization who created the 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. If you want to update this value, see UpdateDocument.
requires :: Maybe (NonEmpty DocumentRequires)
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
tags :: Maybe [Tag]
The tags, or metadata, that have been applied to the document.

Instances

Instances details

Eq DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods (==) :: DocumentIdentifier -> DocumentIdentifier -> Bool # (/=) :: DocumentIdentifier -> DocumentIdentifier -> Bool #
Read DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods readsPrec :: Int -> ReadS DocumentIdentifier # readList :: ReadS [DocumentIdentifier] # readPrec :: ReadPrec DocumentIdentifier # readListPrec :: ReadPrec [DocumentIdentifier] #
Show DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods showsPrec :: Int -> DocumentIdentifier -> ShowS # show :: DocumentIdentifier -> String # showList :: [DocumentIdentifier] -> ShowS #
Generic DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Associated Types type Rep DocumentIdentifier :: Type -> Type # Methods from :: DocumentIdentifier -> Rep DocumentIdentifier x # to :: Rep DocumentIdentifier x -> DocumentIdentifier #
NFData DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods rnf :: DocumentIdentifier -> () #
Hashable DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods hashWithSalt :: Int -> DocumentIdentifier -> Int # hash :: DocumentIdentifier -> Int #
FromJSON DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier Methods parseJSON :: Value -> Parser DocumentIdentifier # parseJSONList :: Value -> Parser [DocumentIdentifier] #
type Rep DocumentIdentifier Source #
Instance details Defined in Amazonka.SSM.Types.DocumentIdentifier type Rep DocumentIdentifier = D1 ('MetaData "DocumentIdentifier" "Amazonka.SSM.Types.DocumentIdentifier" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DocumentIdentifier'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "documentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentType)) :: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schemaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "reviewStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewStatus)) :: S1 ('MetaSel ('Just "targetType") '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 "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "documentFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentFormat))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentRequires))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newDocumentIdentifier :: DocumentIdentifier Source #

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:documentType:DocumentIdentifier', documentIdentifier_documentType - The document type.

$sel:versionName: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.

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

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

$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.

$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:createdDate:DocumentIdentifier', documentIdentifier_createdDate - The date the SSM document was created.

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

$sel:name:DocumentIdentifier', documentIdentifier_name - The name of the SSM document.

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

$sel:author:DocumentIdentifier', documentIdentifier_author - The user in your organization who created the document.

$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:requires:DocumentIdentifier', documentIdentifier_requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

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

documentIdentifier_documentType :: Lens' DocumentIdentifier (Maybe DocumentType) Source #

The document type.

documentIdentifier_versionName :: Lens' DocumentIdentifier (Maybe Text) Source #

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_schemaVersion :: Lens' DocumentIdentifier (Maybe Text) Source #

The schema version.

documentIdentifier_reviewStatus :: Lens' DocumentIdentifier (Maybe ReviewStatus) Source #

The current status of a document review.

documentIdentifier_targetType :: Lens' DocumentIdentifier (Maybe Text) Source #

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_owner :: Lens' DocumentIdentifier (Maybe Text) Source #

The Amazon Web Services user account that created the document.

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

The operating system platform.

documentIdentifier_createdDate :: Lens' DocumentIdentifier (Maybe UTCTime) Source #

The date the SSM document was created.

documentIdentifier_documentFormat :: Lens' DocumentIdentifier (Maybe DocumentFormat) Source #

The document format, either JSON or YAML.

documentIdentifier_name :: Lens' DocumentIdentifier (Maybe Text) Source #

The name of the SSM document.

documentIdentifier_documentVersion :: Lens' DocumentIdentifier (Maybe Text) Source #

The document version.

documentIdentifier_author :: Lens' DocumentIdentifier (Maybe Text) Source #

The user in your organization who created the document.

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

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

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

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

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