DocumentState class

Input properties used for looking up and filtering Document resources.

Constructors

DocumentState({Input<String?>? arn, Input<List<DocumentAttachmentsSource>?>? attachmentsSources, Input<String?>? content, Input<String?>? createdDate, Input<String?>? defaultVersion, Input<String?>? description, Input<String?>? documentFormat, Input<String?>? documentType, Input<String?>? documentVersion, Input<String?>? hash, Input<String?>? hashType, Input<String?>? latestVersion, Input<String?>? name, Input<String?>? owner, Input<List<DocumentParameter>?>? parameters, Input<Map<String, String>?>? permissions, Input<List<String>?>? platformTypes, Input<String?>? region, Input<String?>? schemaVersion, Input<String?>? status, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? targetType, Input<String?>? versionName})
Creates a new DocumentState. arn ARN of the document. attachmentsSources One or more configuration blocks describing attachments sources to a version of a document. See attachmentsSource block below for details. content The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. createdDate The date the document was created. defaultVersion The default version of the document. description A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional. documentFormat The format of the document. Valid values: JSON, TEXT, YAML. documentType The type of the document. For a list of valid values, see the API Reference. documentVersion The document version. hash The Sha256 or Sha1 hash created by the system when the document was created. hashType The hash type of the document. Valid values: Sha256, Sha1. latestVersion The latest version of the document. name The name of the document. owner The Amazon Web Services user that created the document. parameters One or more configuration blocks describing the parameters for the document. See parameter block below for details. permissions Additional permissions to attach to the document. See Permissions below for details. platformTypes The list of operating system (OS) platforms compatible with this SSM document. Valid values: Windows, Linux, MacOS. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. schemaVersion The schema version of the document. status The status of the SSM document. Valid values: Creating, Active, Updating, Deleting, Failed. tags A map of tags to assign to the object. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. 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 AWS resource and property types reference. versionName 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.
const
DocumentState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the document.
final
attachmentsSources → Input<List<DocumentAttachmentsSource>?>?
One or more configuration blocks describing attachments sources to a version of a document. See attachmentsSource block below for details.
final
content → Input<String?>?
The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.
final
createdDate → Input<String?>?
The date the document was created.
final
defaultVersion → Input<String?>?
The default version of the document.
final
description → Input<String?>?
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
final
documentFormat → Input<String?>?
The format of the document. Valid values: JSON, TEXT, YAML.
final
documentType → Input<String?>?
The type of the document. For a list of valid values, see the API Reference.
final
documentVersion → Input<String?>?
The document version.
final
hash → Input<String?>?
The Sha256 or Sha1 hash created by the system when the document was created.
final
hashCode → int
The hash code for this object.
no setterinherited
hashType → Input<String?>?
The hash type of the document. Valid values: Sha256, Sha1.
final
latestVersion → Input<String?>?
The latest version of the document.
final
name → Input<String?>?
The name of the document.
final
owner → Input<String?>?
The Amazon Web Services user that created the document.
final
parameters → Input<List<DocumentParameter>?>?
One or more configuration blocks describing the parameters for the document. See parameter block below for details.
final
permissions → Input<Map<String, String>?>?
Additional permissions to attach to the document. See Permissions below for details.
final
platformTypes → Input<List<String>?>?
The list of operating system (OS) platforms compatible with this SSM document. Valid values: Windows, Linux, MacOS.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaVersion → Input<String?>?
The schema version of the document.
final
status → Input<String?>?
The status of the SSM document. Valid values: Creating, Active, Updating, Deleting, Failed.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the object. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
targetType → Input<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 AWS resource and property types reference.
final
versionName → Input<String?>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited