ssm/aws.sdk.kotlin.services.ssm.model/DocumentDescription

DocumentDescription

class DocumentDescription

Describes an Amazon Web Services Systems Manager document (SSM document).

Types

object Companion

Properties

approvedVersion

val approvedVersion: String?

The version of the document currently approved for use in the organization.

attachmentsInformation

val attachmentsInformation: List<AttachmentInformation>?

Details about the document attachments, including names, locations, sizes, and so on.

val author: String?

The user in your organization who created the document.

val category: List<String>?

The classification of a document to help you identify and categorize its use.

val categoryEnum: List<String>?

The value that identifies a document's category.

val createdDate: Instant?

The date when the document was created.

val defaultVersion: String?

The default version.

val description: String?

A description of the document.

val displayName: String?

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

val documentFormat: DocumentFormat?

The document format, either JSON or YAML.

val documentType: DocumentType?

The type of document.

documentVersion

val documentVersion: String?

The document version.

val hash: String?

The Sha256 or Sha1 hash created by the system when the document was created.

val hashType: DocumentHashType?

The hash type of the document. Valid values include Sha256 or Sha1.

val latestVersion: String?

The latest version of the document.

val name: String?

The name of the SSM document.

val owner: String?

The Amazon Web Services user that created the document.

val parameters: List<DocumentParameter>?

A description of the parameters for a document.

pendingReviewVersion

val pendingReviewVersion: String?

The version of the document that is currently under review.

val platformTypes: List<PlatformType>?

The list of operating system (OS) platforms compatible with this SSM document.

val requires: List<DocumentRequires>?

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

reviewInformation

val reviewInformation: List<ReviewInformation>?

Details about the review of a document.

val reviewStatus: ReviewStatus?

The current status of the review.

val schemaVersion: String?

The schema version.

val sha1: String?

The SHA1 hash of the document, which you can use for verification.

val status: DocumentStatus?

The status of the SSM document.

statusInformation

val statusInformation: String?

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

val tags: List<Tag>?

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

val targetType: String?

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.

val versionName: String?

The version of the artifact associated with the document.

Functions

inline fun copy(block: DocumentDescription.Builder.() -> Unit = {}): DocumentDescription

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String