Class DocumentConfig

SecurityConfig / CentralSecurityServicesConfig / SsmAutomationConfig / DocumentSetConfig / DocumentConfig

https://docs.aws.amazon.com/systems-manager/latest/userguide/documents.html | AWS Systems Manager document configuration

Description

Use this configuration to define AWS System Manager documents (SSM documents) that can be used on managed instances in an environment.

Example

- name: SSM-ELB-Enable-Logging
  template: path/to/document.yaml

Hierarchy

  • DocumentConfig

Implements

Constructors

constructor

Properties

name targetType template

Constructors

constructor

Properties

Readonly name

name: string = ''

Name of document to be created

Readonly targetType

targetType: undefined | string = undefined

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide. Ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html Length Constraints: Maximum length of 200. Pattern: ^/[\w.-:/]*$

Readonly template

template: string = ''

Document template file path. This file must be available in accelerator config repository.

Settings

Member Visibility

Theme

Generated using TypeDoc