/AWS1/CL_SSMDOCUMENTIDENTIFIER

Describes the name of a SSM document.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/SSMDOCUMENTARN /AWS1/SSMDOCUMENTARN

The name of the SSM document.

iv_createddate TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

The date the SSM document was created.

iv_displayname TYPE /AWS1/SSMDOCUMENTDISPLAYNAME /AWS1/SSMDOCUMENTDISPLAYNAME

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.

iv_owner TYPE /AWS1/SSMDOCUMENTOWNER /AWS1/SSMDOCUMENTOWNER

The Amazon Web Services user that created the document.

iv_versionname TYPE /AWS1/SSMDOCUMENTVERSIONNAME /AWS1/SSMDOCUMENTVERSIONNAME

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

it_platformtypes TYPE /AWS1/CL_SSMPLATFORMTYPELIST_W=>TT_PLATFORMTYPELIST TT_PLATFORMTYPELIST

The operating system platform.

iv_documentversion TYPE /AWS1/SSMDOCUMENTVERSION /AWS1/SSMDOCUMENTVERSION

The document version.

iv_documenttype TYPE /AWS1/SSMDOCUMENTTYPE /AWS1/SSMDOCUMENTTYPE

The document type.

iv_schemaversion TYPE /AWS1/SSMDOCUMENTSCHEMAVERSION /AWS1/SSMDOCUMENTSCHEMAVERSION

The schema version.

iv_documentformat TYPE /AWS1/SSMDOCUMENTFORMAT /AWS1/SSMDOCUMENTFORMAT

The document format, either JSON or YAML.

iv_targettype TYPE /AWS1/SSMTARGETTYPE /AWS1/SSMTARGETTYPE

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.

it_tags TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST TT_TAGLIST

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

it_requires TYPE /AWS1/CL_SSMDOCUMENTREQUIRES=>TT_DOCUMENTREQUIRESLIST TT_DOCUMENTREQUIRESLIST

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

iv_reviewstatus TYPE /AWS1/SSMREVIEWSTATUS /AWS1/SSMREVIEWSTATUS

The current status of a document review.

iv_author TYPE /AWS1/SSMDOCUMENTAUTHOR /AWS1/SSMDOCUMENTAUTHOR

The user in your organization who created the document.

---

Queryable Attributes

Name

The name of the SSM document.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

CreatedDate

The date the SSM document was created.

Accessible with the following methods

Method	Description
GET_CREATEDDATE()	Getter for CREATEDDATE, with configurable default
ASK_CREATEDDATE()	Getter for CREATEDDATE w/ exceptions if field has no value
HAS_CREATEDDATE()	Determine if CREATEDDATE has a value

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.

Accessible with the following methods

Method	Description
GET_DISPLAYNAME()	Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME()	Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME()	Determine if DISPLAYNAME has a value

Owner

The Amazon Web Services user that created the document.

Accessible with the following methods

Method	Description
GET_OWNER()	Getter for OWNER, with configurable default
ASK_OWNER()	Getter for OWNER w/ exceptions if field has no value
HAS_OWNER()	Determine if OWNER has a value

VersionName

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

Accessible with the following methods

Method	Description
GET_VERSIONNAME()	Getter for VERSIONNAME, with configurable default
ASK_VERSIONNAME()	Getter for VERSIONNAME w/ exceptions if field has no value
HAS_VERSIONNAME()	Determine if VERSIONNAME has a value

PlatformTypes

The operating system platform.

Accessible with the following methods

Method	Description
GET_PLATFORMTYPES()	Getter for PLATFORMTYPES, with configurable default
ASK_PLATFORMTYPES()	Getter for PLATFORMTYPES w/ exceptions if field has no value
HAS_PLATFORMTYPES()	Determine if PLATFORMTYPES has a value

DocumentVersion

The document version.

Accessible with the following methods

Method	Description
GET_DOCUMENTVERSION()	Getter for DOCUMENTVERSION, with configurable default
ASK_DOCUMENTVERSION()	Getter for DOCUMENTVERSION w/ exceptions if field has no val
HAS_DOCUMENTVERSION()	Determine if DOCUMENTVERSION has a value

DocumentType

The document type.

Accessible with the following methods

Method	Description
GET_DOCUMENTTYPE()	Getter for DOCUMENTTYPE, with configurable default
ASK_DOCUMENTTYPE()	Getter for DOCUMENTTYPE w/ exceptions if field has no value
HAS_DOCUMENTTYPE()	Determine if DOCUMENTTYPE has a value

SchemaVersion

The schema version.

Accessible with the following methods

Method	Description
GET_SCHEMAVERSION()	Getter for SCHEMAVERSION, with configurable default
ASK_SCHEMAVERSION()	Getter for SCHEMAVERSION w/ exceptions if field has no value
HAS_SCHEMAVERSION()	Determine if SCHEMAVERSION has a value

DocumentFormat

The document format, either JSON or YAML.

Accessible with the following methods

Method	Description
GET_DOCUMENTFORMAT()	Getter for DOCUMENTFORMAT, with configurable default
ASK_DOCUMENTFORMAT()	Getter for DOCUMENTFORMAT w/ exceptions if field has no valu
HAS_DOCUMENTFORMAT()	Determine if DOCUMENTFORMAT has a value

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.

Accessible with the following methods

Method	Description
GET_TARGETTYPE()	Getter for TARGETTYPE, with configurable default
ASK_TARGETTYPE()	Getter for TARGETTYPE w/ exceptions if field has no value
HAS_TARGETTYPE()	Determine if TARGETTYPE has a value

Tags

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

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

Requires

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

Accessible with the following methods

Method	Description
GET_REQUIRES()	Getter for REQUIRES, with configurable default
ASK_REQUIRES()	Getter for REQUIRES w/ exceptions if field has no value
HAS_REQUIRES()	Determine if REQUIRES has a value

ReviewStatus

The current status of a document review.

Accessible with the following methods

Method	Description
GET_REVIEWSTATUS()	Getter for REVIEWSTATUS, with configurable default
ASK_REVIEWSTATUS()	Getter for REVIEWSTATUS w/ exceptions if field has no value
HAS_REVIEWSTATUS()	Determine if REVIEWSTATUS has a value

Author

The user in your organization who created the document.

Accessible with the following methods

Method	Description
GET_AUTHOR()	Getter for AUTHOR, with configurable default
ASK_AUTHOR()	Getter for AUTHOR w/ exceptions if field has no value
HAS_AUTHOR()	Determine if AUTHOR has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_DOCUMENTIDENTIFIERLIST

TYPES TT_DOCUMENTIDENTIFIERLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMDOCUMENTIDENTIFIER WITH DEFAULT KEY
.