DocumentState class
Input properties used for looking up and filtering Document resources.
Constructors
-
DocumentState({Input<
String?> ? arn, Input<List< ? attachmentsSources, Input<DocumentAttachmentsSource> ?>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< ? parameters, Input<DocumentParameter> ?>Map< ? permissions, Input<String, String> ?>List< ? platformTypes, Input<String> ?>String?> ? region, Input<String?> ? schemaVersion, Input<String?> ? status, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? targetType, Input<String?> ? versionName}) -
Creates a new DocumentState.
arnARN of the document.attachmentsSourcesOne or more configuration blocks describing attachments sources to a version of a document. SeeattachmentsSourceblock below for details.contentThe 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.createdDateThe date the document was created.defaultVersionThe default version of the document.descriptionA description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.documentFormatThe format of the document. Valid values:JSON,TEXT,YAML.documentTypeThe type of the document. For a list of valid values, see the API Reference.documentVersionThe document version.hashThe Sha256 or Sha1 hash created by the system when the document was created.hashTypeThe hash type of the document. Valid values:Sha256,Sha1.latestVersionThe latest version of the document.nameThe name of the document.ownerThe Amazon Web Services user that created the document.parametersOne or more configuration blocks describing the parameters for the document. Seeparameterblock below for details.permissionsAdditional permissions to attach to the document. See Permissions below for details.platformTypesThe list of operating system (OS) platforms compatible with this SSM document. Valid values:Windows,Linux,MacOS.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.schemaVersionThe schema version of the document.statusThe status of the SSM document. Valid values:Creating,Active,Updating,Deleting,Failed.tagsA map of tags to assign to the object. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.targetTypeThe 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.versionNameThe 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
attachmentsSourceblock 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
parameterblock 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 -
A map of tags to assign to the object. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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