DocumentArgs class
The set of arguments for Document. The set of arguments for Document.
Constructors
-
DocumentArgs({Input<
List< ? attachmentsSources, required Input<DocumentAttachmentsSource> ?>String> content, Input<String?> ? documentFormat, required Input<String> documentType, Input<String?> ? name, Input<Map< ? permissions, Input<String, String> ?>String?> ? region, Input<Map< ? tags, Input<String, String> ?>String?> ? targetType, Input<String?> ? versionName}) -
Creates a new DocumentArgs.
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.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.nameThe name of the document.permissionsAdditional permissions to attach to the document. See Permissions below for details.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.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.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 -
DocumentArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
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
-
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
- hashCode → int
-
The hash code for this object.
no setterinherited
-
name
→ Input<
String?> ? -
The name of the document.
final
-
permissions
→ Input<
Map< ?String, String> ?> -
Additional permissions to attach to the document. See Permissions below for details.
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
-
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 -
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