# API Reference ## Constructs ### ApplicationsStep CommandStep implemenation for aws:applications https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-applications. #### Initializers ```typescript import { ApplicationsStep } from '@cdklabs/cdk-ssm-documents' new ApplicationsStep(scope: Construct, id: string, props: ApplicationsStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ApplicationsStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ApplicationsStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ApplicationsStep } from '@cdklabs/cdk-ssm-documents' ApplicationsStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | installAction | IInstallUninstallRepairVariable | *No description.* | | source | IStringVariable | *No description.* | | parameters | IStringVariable | *No description.* | | sourceHash | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `installAction`Required ```typescript public readonly installAction: IInstallUninstallRepairVariable; ``` - *Type:* IInstallUninstallRepairVariable --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable --- ##### `parameters`Optional ```typescript public readonly parameters: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceHash`Optional ```typescript public readonly sourceHash: IStringVariable; ``` - *Type:* IStringVariable --- ### ApproveStep AutomationStep implementation for aws:approve https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-approve.html. #### Initializers ```typescript import { ApproveStep } from '@cdklabs/cdk-ssm-documents' new ApproveStep(scope: Construct, id: string, props: ApproveStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ApproveStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ApproveStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ApproveStep } from '@cdklabs/cdk-ssm-documents' ApproveStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | approvers | IStringListVariable | *No description.* | | message | IStringVariable | *No description.* | | minRequiredApprovals | INumberVariable | *No description.* | | notificationArn | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `approvers`Required ```typescript public readonly approvers: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `message`Optional ```typescript public readonly message: IStringVariable; ``` - *Type:* IStringVariable --- ##### `minRequiredApprovals`Optional ```typescript public readonly minRequiredApprovals: INumberVariable; ``` - *Type:* INumberVariable --- ##### `notificationArn`Optional ```typescript public readonly notificationArn: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### AssertAwsResourceStep AutomationStep implementation of aws:assertAwsResourceProperty. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-assertAwsResourceProperty.html #### Initializers ```typescript import { AssertAwsResourceStep } from '@cdklabs/cdk-ssm-documents' new AssertAwsResourceStep(scope: Construct, id: string, props: AssertAwsResourceStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AssertAwsResourceStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AssertAwsResourceStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). | | listOutputs | There are no outputs for this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` There are no outputs for this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AssertAwsResourceStep } from '@cdklabs/cdk-ssm-documents' AssertAwsResourceStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | apiParams | DictFormat | *No description.* | | javaScriptApi | string | *No description.* | | outputs | Output[] | *No description.* | | pascalCaseApi | string | *No description.* | | service | AwsService | *No description.* | | desiredValues | string[] | *No description.* | | selector | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `apiParams`Required ```typescript public readonly apiParams: DictFormat; ``` - *Type:* DictFormat --- ##### `javaScriptApi`Required ```typescript public readonly javaScriptApi: string; ``` - *Type:* string --- ##### `outputs`Required ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] --- ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string --- ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService --- ##### `desiredValues`Required ```typescript public readonly desiredValues: string[]; ``` - *Type:* string[] --- ##### `selector`Required ```typescript public readonly selector: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### AutomationDocument The AutomationDocuemnt used to both build the SSM Automation yaml/json and to use in simulation. The AutomationDocument will delegate execution responsibility to the AutomationSteps that it receives. The SsmDocument parent class contains methods to runSimulation() as well as print(). #### Initializers ```typescript import { AutomationDocument } from '@cdklabs/cdk-ssm-documents' new AutomationDocument(scope: Construct, id: string, props: AutomationDocumentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AutomationDocumentProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AutomationDocumentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | documentType | *No description.* | | print | Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); | | addStep | *No description.* | | collectedSteps | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `documentType` ```typescript public documentType(): string ``` ##### `print` ```typescript public print(): string ``` Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); Converts the objects define in the SSM Document (including all of the steps) to an SSM document string. The format is dependency on the documentFormat property provided to the class. The yaml can be used as is and will behave (or at least should behave) as was simulated in the runSimulation(). ##### `addStep` ```typescript public addStep(component: IAutomationComponent): void ``` ###### `component`Required - *Type:* IAutomationComponent --- ##### `collectedSteps` ```typescript public collectedSteps(): AutomationStep[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AutomationDocument } from '@cdklabs/cdk-ssm-documents' AutomationDocument.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnDocument | aws-cdk-lib.aws_ssm.CfnDocument | *No description.* | | description | string | *No description.* | | docInputs | Input[] | *No description.* | | docOutputs | DocumentOutput[] | *No description.* | | documentName | string | *No description.* | | props | SsmDocumentProps | *No description.* | | assumeRole | IStringVariable | *No description.* | | header | string | *No description.* | | builder | AutomationDocumentBuilder | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnDocument`Required ```typescript public readonly cfnDocument: CfnDocument; ``` - *Type:* aws-cdk-lib.aws_ssm.CfnDocument --- ##### `description`Required ```typescript public readonly description: string; ``` - *Type:* string --- ##### `docInputs`Required ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] --- ##### `docOutputs`Required ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string --- ##### `props`Required ```typescript public readonly props: SsmDocumentProps; ``` - *Type:* SsmDocumentProps --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string --- ##### `builder`Required ```typescript public readonly builder: AutomationDocumentBuilder; ``` - *Type:* AutomationDocumentBuilder --- ### AutomationStep - *Implements:* IAutomationComponent Parent class for AutomationSteps. These steps are using in an AutomationDocument. You can instantiate steps using the AutomationBuilder for convenience. You can use these steps to simulate their execution (mimics the SSM run) AND to build their yaml/json declaration. Control flow of the subsequent step is determined by the currently executing step. The flow of the execution therefore follows a chain-of-responsibility pattern. The inputs received into a step AND the outputs of previous steps are merged to form inputs of subsequent steps. #### Initializers ```typescript import { AutomationStep } from '@cdklabs/cdk-ssm-documents' new AutomationStep(scope: Construct, id: string, props: AutomationStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AutomationStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AutomationStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AutomationStep } from '@cdklabs/cdk-ssm-documents' AutomationStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### AwsApiStep AutomationStep implementation of aws:executeAwsApi. #### Initializers ```typescript import { AwsApiStep } from '@cdklabs/cdk-ssm-documents' new AwsApiStep(scope: Construct, id: string, props: AwsApiStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AwsApiStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AwsApiStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AwsApiStep } from '@cdklabs/cdk-ssm-documents' AwsApiStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | apiParams | DictFormat | *No description.* | | javaScriptApi | string | *No description.* | | outputs | Output[] | *No description.* | | pascalCaseApi | string | *No description.* | | service | AwsService | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `apiParams`Required ```typescript public readonly apiParams: DictFormat; ``` - *Type:* DictFormat --- ##### `javaScriptApi`Required ```typescript public readonly javaScriptApi: string; ``` - *Type:* string --- ##### `outputs`Required ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] --- ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string --- ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### BranchStep AutomationStep implementation of aws:branch https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-branch.html. #### Initializers ```typescript import { BranchStep } from '@cdklabs/cdk-ssm-documents' new BranchStep(scope: Construct, id: string, props: BranchStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | BranchStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* BranchStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | There is no output from branch steps. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` There is no output from branch steps. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { BranchStep } from '@cdklabs/cdk-ssm-documents' BranchStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | choices | Choice[] | *No description.* | | defaultStepName | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `choices`Required ```typescript public readonly choices: Choice[]; ``` - *Type:* Choice[] --- ##### `defaultStepName`Optional ```typescript public readonly defaultStepName: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### ChangeInstanceStateStep AutomationStep implemenation for aws:changeInstanceState https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-changestate.html. #### Initializers ```typescript import { ChangeInstanceStateStep } from '@cdklabs/cdk-ssm-documents' new ChangeInstanceStateStep(scope: Construct, id: string, props: ChangeInstanceStateStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ChangeInstanceStateStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ChangeInstanceStateStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | This step has no outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` This step has no outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ChangeInstanceStateStep } from '@cdklabs/cdk-ssm-documents' ChangeInstanceStateStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | desiredState | IDesiredStateVariable | *No description.* | | instanceIds | IStringListVariable | *No description.* | | additionalInfo | IStringVariable | *No description.* | | checkStateOnly | IBooleanVariable | *No description.* | | force | IBooleanVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `desiredState`Required ```typescript public readonly desiredState: IDesiredStateVariable; ``` - *Type:* IDesiredStateVariable --- ##### `instanceIds`Required ```typescript public readonly instanceIds: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `additionalInfo`Optional ```typescript public readonly additionalInfo: IStringVariable; ``` - *Type:* IStringVariable --- ##### `checkStateOnly`Optional ```typescript public readonly checkStateOnly: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `force`Optional ```typescript public readonly force: IBooleanVariable; ``` - *Type:* IBooleanVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### CommandDocument https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html The CommandDocument will delegate execution responsibility to the CammandSteps that it receives. The SsmDocument parent class contains methods to runSimulation() as well as print(). #### Initializers ```typescript import { CommandDocument } from '@cdklabs/cdk-ssm-documents' new CommandDocument(scope: Construct, id: string, props: CommandDocumentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CommandDocumentProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CommandDocumentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | documentType | *No description.* | | print | Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); | | addStep | *No description.* | | collectedSteps | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `documentType` ```typescript public documentType(): string ``` ##### `print` ```typescript public print(): string ``` Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); Converts the objects define in the SSM Document (including all of the steps) to an SSM document string. The format is dependency on the documentFormat property provided to the class. The yaml can be used as is and will behave (or at least should behave) as was simulated in the runSimulation(). ##### `addStep` ```typescript public addStep(component: ICommandComponent): void ``` ###### `component`Required - *Type:* ICommandComponent --- ##### `collectedSteps` ```typescript public collectedSteps(): CommandStep[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CommandDocument } from '@cdklabs/cdk-ssm-documents' CommandDocument.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnDocument | aws-cdk-lib.aws_ssm.CfnDocument | *No description.* | | description | string | *No description.* | | docInputs | Input[] | *No description.* | | docOutputs | DocumentOutput[] | *No description.* | | documentName | string | *No description.* | | props | SsmDocumentProps | *No description.* | | assumeRole | IStringVariable | *No description.* | | header | string | *No description.* | | builder | CommandDocumentBuilder | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnDocument`Required ```typescript public readonly cfnDocument: CfnDocument; ``` - *Type:* aws-cdk-lib.aws_ssm.CfnDocument --- ##### `description`Required ```typescript public readonly description: string; ``` - *Type:* string --- ##### `docInputs`Required ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] --- ##### `docOutputs`Required ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string --- ##### `props`Required ```typescript public readonly props: SsmDocumentProps; ``` - *Type:* SsmDocumentProps --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string --- ##### `builder`Required ```typescript public readonly builder: CommandDocumentBuilder; ``` - *Type:* CommandDocumentBuilder --- ### CommandStep - *Implements:* ICommandComponent #### Initializers ```typescript import { CommandStep } from '@cdklabs/cdk-ssm-documents' new CommandStep(scope: Construct, id: string, props: CommandStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CommandStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CommandStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CommandStep } from '@cdklabs/cdk-ssm-documents' CommandStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ### CompositeAutomationStep - *Implements:* IAutomationComponent #### Initializers ```typescript import { CompositeAutomationStep } from '@cdklabs/cdk-ssm-documents' new CompositeAutomationStep(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addToDocument | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CompositeAutomationStep } from '@cdklabs/cdk-ssm-documents' CompositeAutomationStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### CompositeCommandStep - *Implements:* ICommandComponent #### Initializers ```typescript import { CompositeCommandStep } from '@cdklabs/cdk-ssm-documents' new CompositeCommandStep(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addToDocument | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CompositeCommandStep } from '@cdklabs/cdk-ssm-documents' CompositeCommandStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### ConfigureDockerStep AutomationStep implemenation for aws:UpdateAgent https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-configuredocker. #### Initializers ```typescript import { ConfigureDockerStep } from '@cdklabs/cdk-ssm-documents' new ConfigureDockerStep(scope: Construct, id: string, props: ConfigureDockerStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ConfigureDockerStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ConfigureDockerStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ConfigureDockerStep } from '@cdklabs/cdk-ssm-documents' ConfigureDockerStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | installAction | IActionVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `installAction`Required ```typescript public readonly installAction: IActionVariable; ``` - *Type:* IActionVariable --- ### ConfigurePackageStep CommandStep implemenation for aws:configurePackage https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-configurepackage. #### Initializers ```typescript import { ConfigurePackageStep } from '@cdklabs/cdk-ssm-documents' new ConfigurePackageStep(scope: Construct, id: string, props: ConfigurePackageStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ConfigurePackageStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ConfigurePackageStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command include ... | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command include ... ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ConfigurePackageStep } from '@cdklabs/cdk-ssm-documents' ConfigurePackageStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | packageAction | IActionVariable | *No description.* | | packageName | IPackageNameVariable | *No description.* | | additionalArguments | IStringMapVariable | *No description.* | | installationType | IInstallationTypeVariable | *No description.* | | version | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `packageAction`Required ```typescript public readonly packageAction: IActionVariable; ``` - *Type:* IActionVariable --- ##### `packageName`Required ```typescript public readonly packageName: IPackageNameVariable; ``` - *Type:* IPackageNameVariable --- ##### `additionalArguments`Optional ```typescript public readonly additionalArguments: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `installationType`Optional ```typescript public readonly installationType: IInstallationTypeVariable; ``` - *Type:* IInstallationTypeVariable --- ##### `version`Optional ```typescript public readonly version: IStringVariable; ``` - *Type:* IStringVariable --- ### CopyImageStep AutomationStep implemenation for aws:copyImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-copyimage.html. #### Initializers ```typescript import { CopyImageStep } from '@cdklabs/cdk-ssm-documents' new CopyImageStep(scope: Construct, id: string, props: CopyImageStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CopyImageStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CopyImageStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CopyImageStep } from '@cdklabs/cdk-ssm-documents' CopyImageStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | imageName | IStringVariable | *No description.* | | sourceImageId | IStringVariable | *No description.* | | sourceRegion | IStringVariable | *No description.* | | clientToken | IStringVariable | *No description.* | | encrypted | IBooleanVariable | *No description.* | | imageDescription | IStringVariable | *No description.* | | kmsKeyId | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `imageName`Required ```typescript public readonly imageName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceImageId`Required ```typescript public readonly sourceImageId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceRegion`Required ```typescript public readonly sourceRegion: IStringVariable; ``` - *Type:* IStringVariable --- ##### `clientToken`Optional ```typescript public readonly clientToken: IStringVariable; ``` - *Type:* IStringVariable --- ##### `encrypted`Optional ```typescript public readonly encrypted: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `imageDescription`Optional ```typescript public readonly imageDescription: IStringVariable; ``` - *Type:* IStringVariable --- ##### `kmsKeyId`Optional ```typescript public readonly kmsKeyId: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### CreateImageStep AutomationStep implemenation for aws:createImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-create.html. #### Initializers ```typescript import { CreateImageStep } from '@cdklabs/cdk-ssm-documents' new CreateImageStep(scope: Construct, id: string, props: CreateImageStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CreateImageStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CreateImageStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CreateImageStep } from '@cdklabs/cdk-ssm-documents' CreateImageStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | imageName | IStringVariable | *No description.* | | instanceId | IStringVariable | *No description.* | | blockDeviceMappings | IStringMapVariable | *No description.* | | imageDescription | IStringVariable | *No description.* | | noReboot | IBooleanVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `imageName`Required ```typescript public readonly imageName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `instanceId`Required ```typescript public readonly instanceId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `blockDeviceMappings`Optional ```typescript public readonly blockDeviceMappings: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `imageDescription`Optional ```typescript public readonly imageDescription: IStringVariable; ``` - *Type:* IStringVariable --- ##### `noReboot`Optional ```typescript public readonly noReboot: IBooleanVariable; ``` - *Type:* IBooleanVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### CreateStackStep AutomationStep implementation for aws:createStack https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-createstack.html. #### Initializers ```typescript import { CreateStackStep } from '@cdklabs/cdk-ssm-documents' new CreateStackStep(scope: Construct, id: string, props: CreateStackStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CreateStackStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CreateStackStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CreateStackStep } from '@cdklabs/cdk-ssm-documents' CreateStackStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | stackName | IStringVariable | *No description.* | | capabilities | IStringListVariable | *No description.* | | clientRequestToken | IStringVariable | *No description.* | | notificationARNs | IStringListVariable | *No description.* | | onStackFailure | IOnFailureVariable | *No description.* | | parameters | IMapListVariable | *No description.* | | resourceTypes | IStringListVariable | *No description.* | | roleArn | IStringVariable | *No description.* | | stackPolicyBody | IStringVariable | *No description.* | | stackPolicyUrl | IStringVariable | *No description.* | | tags | IMapListVariable | *No description.* | | templateBody | IStringVariable | *No description.* | | templateUrl | IStringVariable | *No description.* | | timeoutInMinutes | INumberVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `stackName`Required ```typescript public readonly stackName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `capabilities`Optional ```typescript public readonly capabilities: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `clientRequestToken`Optional ```typescript public readonly clientRequestToken: IStringVariable; ``` - *Type:* IStringVariable --- ##### `notificationARNs`Optional ```typescript public readonly notificationARNs: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `onStackFailure`Optional ```typescript public readonly onStackFailure: IOnFailureVariable; ``` - *Type:* IOnFailureVariable --- ##### `parameters`Optional ```typescript public readonly parameters: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `resourceTypes`Optional ```typescript public readonly resourceTypes: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `roleArn`Optional ```typescript public readonly roleArn: IStringVariable; ``` - *Type:* IStringVariable --- ##### `stackPolicyBody`Optional ```typescript public readonly stackPolicyBody: IStringVariable; ``` - *Type:* IStringVariable --- ##### `stackPolicyUrl`Optional ```typescript public readonly stackPolicyUrl: IStringVariable; ``` - *Type:* IStringVariable --- ##### `tags`Optional ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `templateBody`Optional ```typescript public readonly templateBody: IStringVariable; ``` - *Type:* IStringVariable --- ##### `templateUrl`Optional ```typescript public readonly templateUrl: IStringVariable; ``` - *Type:* IStringVariable --- ##### `timeoutInMinutes`Optional ```typescript public readonly timeoutInMinutes: INumberVariable; ``` - *Type:* INumberVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### CreateTagsStep AutomationStep implemenation for aws:createTags https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-createtag.html. #### Initializers ```typescript import { CreateTagsStep } from '@cdklabs/cdk-ssm-documents' new CreateTagsStep(scope: Construct, id: string, props: CreateTagsStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CreateTagsStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* CreateTagsStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | This step has no outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` This step has no outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { CreateTagsStep } from '@cdklabs/cdk-ssm-documents' CreateTagsStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | resourceIds | IStringListVariable | *No description.* | | tags | IMapListVariable | *No description.* | | resourceType | IResourceTypeVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `resourceIds`Required ```typescript public readonly resourceIds: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `tags`Required ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `resourceType`Optional ```typescript public readonly resourceType: IResourceTypeVariable; ``` - *Type:* IResourceTypeVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### DeleteImageStep AutomationStep implementation for aws:deleteImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-delete.html. #### Initializers ```typescript import { DeleteImageStep } from '@cdklabs/cdk-ssm-documents' new DeleteImageStep(scope: Construct, id: string, props: DeleteImageStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DeleteImageStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* DeleteImageStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | This step has no outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` This step has no outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DeleteImageStep } from '@cdklabs/cdk-ssm-documents' DeleteImageStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | imageId | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `imageId`Required ```typescript public readonly imageId: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### DeleteStackStep AutomationStep implemenation for aws:deleteStack https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-deletestack.html. #### Initializers ```typescript import { DeleteStackStep } from '@cdklabs/cdk-ssm-documents' new DeleteStackStep(scope: Construct, id: string, props: DeleteStackStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DeleteStackStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* DeleteStackStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | The input required for this step is the stackNameVariable. | | listOutputs | No outputs emitted from Delete Stack step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` The input required for this step is the stackNameVariable. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` No outputs emitted from Delete Stack step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DeleteStackStep } from '@cdklabs/cdk-ssm-documents' DeleteStackStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | stackNameVariable | IStringVariable | *No description.* | | roleArn | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `stackNameVariable`Required ```typescript public readonly stackNameVariable: IStringVariable; ``` - *Type:* IStringVariable --- ##### `roleArn`Optional ```typescript public readonly roleArn: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### DomainJoinStep CommandStep implemenation for aws:softwareInventory https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-domainJoin. #### Initializers ```typescript import { DomainJoinStep } from '@cdklabs/cdk-ssm-documents' new DomainJoinStep(scope: Construct, id: string, props: DomainJoinStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DomainJoinStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* DomainJoinStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | All Inputs for this command are optional. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` All Inputs for this command are optional. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DomainJoinStep } from '@cdklabs/cdk-ssm-documents' DomainJoinStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | directoryId | IStringVariable | *No description.* | | directoryName | IStringVariable | *No description.* | | directoryOU | IStringVariable | *No description.* | | dnsIpAddresses | IStringListVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `directoryId`Required ```typescript public readonly directoryId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `directoryName`Required ```typescript public readonly directoryName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `directoryOU`Optional ```typescript public readonly directoryOU: IStringVariable; ``` - *Type:* IStringVariable --- ##### `dnsIpAddresses`Optional ```typescript public readonly dnsIpAddresses: IStringListVariable; ``` - *Type:* IStringListVariable --- ### DownloadContentStep AutomationStep implemenation for aws:downloadContent https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-downloadContent. #### Initializers ```typescript import { DownloadContentStep } from '@cdklabs/cdk-ssm-documents' new DownloadContentStep(scope: Construct, id: string, props: DownloadContentStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DownloadContentStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* DownloadContentStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command includes both the sourceType and sourceInfo variables and destinationPath if provided. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command includes both the sourceType and sourceInfo variables and destinationPath if provided. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DownloadContentStep } from '@cdklabs/cdk-ssm-documents' DownloadContentStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | downloadableContent | IDownloadableContent | *No description.* | | destinationPath | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `downloadableContent`Required ```typescript public readonly downloadableContent: IDownloadableContent; ``` - *Type:* IDownloadableContent --- ##### `destinationPath`Optional ```typescript public readonly destinationPath: IStringVariable; ``` - *Type:* IStringVariable --- ### ExecuteAutomationStep AutomationStep implementation for aws:executeAutomation https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeAutomation.html. #### Initializers ```typescript import { ExecuteAutomationStep } from '@cdklabs/cdk-ssm-documents' new ExecuteAutomationStep(scope: Construct, id: string, props: ExecuteAutomationStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ExecuteAutomationStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ExecuteAutomationStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ExecuteAutomationStep } from '@cdklabs/cdk-ssm-documents' ExecuteAutomationStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | documentName | IStringVariable | *No description.* | | documentVersion | IStringVariable | *No description.* | | maxConcurrency | IStringVariable | *No description.* | | maxErrors | IStringVariable | *No description.* | | runtimeParameters | IStringMapVariable | *No description.* | | tags | IMapListVariable | *No description.* | | targetLocations | IMapListVariable | *No description.* | | targetMaps | IMapListVariable | *No description.* | | targetParameterName | IStringVariable | *No description.* | | targets | IMapListVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `documentName`Required ```typescript public readonly documentName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `documentVersion`Optional ```typescript public readonly documentVersion: IStringVariable; ``` - *Type:* IStringVariable --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: IStringVariable; ``` - *Type:* IStringVariable --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: IStringVariable; ``` - *Type:* IStringVariable --- ##### `runtimeParameters`Optional ```typescript public readonly runtimeParameters: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `tags`Optional ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetLocations`Optional ```typescript public readonly targetLocations: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetMaps`Optional ```typescript public readonly targetMaps: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetParameterName`Optional ```typescript public readonly targetParameterName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `targets`Optional ```typescript public readonly targets: IMapListVariable; ``` - *Type:* IMapListVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### ExecuteScriptStep AutomationStep implementation for aws:executeScript https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html. #### Initializers ```typescript import { ExecuteScriptStep } from '@cdklabs/cdk-ssm-documents' new ExecuteScriptStep(stage: Construct, id: string, props: ExecuteScriptStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | stage | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ExecuteScriptStepProps | *No description.* | --- ##### `stage`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ExecuteScriptStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ExecuteScriptStep } from '@cdklabs/cdk-ssm-documents' ExecuteScriptStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | code | ScriptCode | *No description.* | | inputs | {[ key: string ]: IGenericVariable} | *No description.* | | language | ScriptLanguage | *No description.* | | outputs | Output[] | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `code`Required ```typescript public readonly code: ScriptCode; ``` - *Type:* ScriptCode --- ##### `inputs`Required ```typescript public readonly inputs: {[ key: string ]: IGenericVariable}; ``` - *Type:* {[ key: string ]: IGenericVariable} --- ##### `language`Required ```typescript public readonly language: ScriptLanguage; ``` - *Type:* ScriptLanguage --- ##### `outputs`Required ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### ExecuteStateMachineStep AutomationStep implementation of [aws:executeStateMachine](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeStateMachine.html). #### Initializers ```typescript import { ExecuteStateMachineStep } from '@cdklabs/cdk-ssm-documents' new ExecuteStateMachineStep(scope: Construct, id: string, props: ExecuteStateMachineStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ExecuteStateMachineStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* ExecuteStateMachineStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | No outputs emitted from Delete Stack step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` No outputs emitted from Delete Stack step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ExecuteStateMachineStep } from '@cdklabs/cdk-ssm-documents' ExecuteStateMachineStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | stateMachineArn | IStringVariable | *No description.* | | executionName | IStringVariable | *No description.* | | input | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `stateMachineArn`Required ```typescript public readonly stateMachineArn: IStringVariable; ``` - *Type:* IStringVariable --- ##### `executionName`Optional ```typescript public readonly executionName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `input`Optional ```typescript public readonly input: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### HelloWorld #### Initializers ```typescript import { HelloWorld } from '@cdklabs/cdk-ssm-documents' new HelloWorld(app: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | app | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `app`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Add a dependency between this stack and another stack. | | addMetadata | Adds an arbitary key-value pair, with information you want to record about the stack. | | addTransform | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. | | exportStringListValue | Create a CloudFormation Export for a string list value. | | exportValue | Create a CloudFormation Export for a string value. | | formatArn | Creates an ARN from components. | | getLogicalId | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. | | regionalFact | Look up a fact value for the given fact for the region of this stack. | | renameLogicalId | Rename a generated logical identities. | | reportMissingContextKey | Indicate that a context key was expected. | | resolve | Resolve a tokenized value in the context of the current stack. | | splitArn | Splits the provided ARN into its components. | | toJsonString | Convert an object, potentially containing tokens, to a JSON string. | | toYamlString | Convert an object, potentially containing tokens, to a YAML string. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(target: Stack, reason?: string): void ``` Add a dependency between this stack and another stack. This can be used to define dependencies between any two stacks within an app, and also supports nested stacks. ###### `target`Required - *Type:* aws-cdk-lib.Stack --- ###### `reason`Optional - *Type:* string --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Adds an arbitary key-value pair, with information you want to record about the stack. These get translated to the Metadata section of the generated template. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* any --- ##### `addTransform` ```typescript public addTransform(transform: string): void ``` Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. Duplicate values are removed when stack is synthesized. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) *Example* ```typescript declare const stack: Stack; stack.addTransform('AWS::Serverless-2016-10-31') ``` ###### `transform`Required - *Type:* string The transform to add. --- ##### `exportStringListValue` ```typescript public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[] ``` Create a CloudFormation Export for a string list value. Returns a string list representing the corresponding `Fn.importValue()` expression for this Export. The export expression is automatically wrapped with an `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only export strings. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. See `exportValue` for an example of this process. ###### `exportedValue`Required - *Type:* any --- ###### `options`Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `exportValue` ```typescript public exportValue(exportedValue: any, options?: ExportValueOptions): string ``` Create a CloudFormation Export for a string value. Returns a string representing the corresponding `Fn.importValue()` expression for this Export. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. ## Example Here is how the process works. Let's say there are two stacks, `producerStack` and `consumerStack`, and `producerStack` has a bucket called `bucket`, which is referenced by `consumerStack` (perhaps because an AWS Lambda Function writes into it, or something like that). It is not safe to remove `producerStack.bucket` because as the bucket is being deleted, `consumerStack` might still be using it. Instead, the process takes two deployments: ### Deployment 1: break the relationship - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether). - In the `ProducerStack` class, call `this.exportValue(this.bucket.bucketName)`. This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken. - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both). ### Deployment 2: remove the bucket resource - You are now free to remove the `bucket` resource from `producerStack`. - Don't forget to remove the `exportValue()` call as well. - Deploy again (this time only the `producerStack` will be changed -- the bucket will be deleted). ###### `exportedValue`Required - *Type:* any --- ###### `options`Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `formatArn` ```typescript public formatArn(components: ArnComponents): string ``` Creates an ARN from components. If `partition`, `region` or `account` are not specified, the stack's partition, region and account will be used. If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to. The ARN will be formatted as follows: arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name} The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'. ###### `components`Required - *Type:* aws-cdk-lib.ArnComponents --- ##### `getLogicalId` ```typescript public getLogicalId(element: CfnElement): string ``` Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. This method is called when a `CfnElement` is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage. This method uses the protected method `allocateLogicalId` to render the logical ID for an element. To modify the naming scheme, extend the `Stack` class and override this method. ###### `element`Required - *Type:* aws-cdk-lib.CfnElement The CloudFormation element for which a logical identity is needed. --- ##### `regionalFact` ```typescript public regionalFact(factName: string, defaultValue?: string): string ``` Look up a fact value for the given fact for the region of this stack. Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time. What regions will be included in the lookup map is controlled by the `@aws-cdk/core:target-partitions` context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included. This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts. If `defaultValue` is not given, it is an error if the fact is unknown for the given region. ###### `factName`Required - *Type:* string --- ###### `defaultValue`Optional - *Type:* string --- ##### `renameLogicalId` ```typescript public renameLogicalId(oldId: string, newId: string): void ``` Rename a generated logical identities. To modify the naming scheme strategy, extend the `Stack` class and override the `allocateLogicalId` method. ###### `oldId`Required - *Type:* string --- ###### `newId`Required - *Type:* string --- ##### `reportMissingContextKey` ```typescript public reportMissingContextKey(report: MissingContext): void ``` Indicate that a context key was expected. Contains instructions which will be emitted into the cloud assembly on how the key should be supplied. ###### `report`Required - *Type:* aws-cdk-lib.cloud_assembly_schema.MissingContext The set of parameters needed to obtain the context. --- ##### `resolve` ```typescript public resolve(obj: any): any ``` Resolve a tokenized value in the context of the current stack. ###### `obj`Required - *Type:* any --- ##### `splitArn` ```typescript public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents ``` Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens). ###### `arn`Required - *Type:* string the ARN to split into its components. --- ###### `arnFormat`Required - *Type:* aws-cdk-lib.ArnFormat the expected format of 'arn' - depends on what format the service 'arn' represents uses. --- ##### `toJsonString` ```typescript public toJsonString(obj: any, space?: number): string ``` Convert an object, potentially containing tokens, to a JSON string. ###### `obj`Required - *Type:* any --- ###### `space`Optional - *Type:* number --- ##### `toYamlString` ```typescript public toYamlString(obj: any): string ``` Convert an object, potentially containing tokens, to a YAML string. ###### `obj`Required - *Type:* any --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isStack | Return whether the given object is a Stack. | | of | Looks up the first stack scope in which `construct` is defined. | --- ##### ~~`isConstruct`~~ ```typescript import { HelloWorld } from '@cdklabs/cdk-ssm-documents' HelloWorld.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- ##### `isStack` ```typescript import { HelloWorld } from '@cdklabs/cdk-ssm-documents' HelloWorld.isStack(x: any) ``` Return whether the given object is a Stack. We do attribute detection since we can't reliably use 'instanceof'. ###### `x`Required - *Type:* any --- ##### `of` ```typescript import { HelloWorld } from '@cdklabs/cdk-ssm-documents' HelloWorld.of(construct: IConstruct) ``` Looks up the first stack scope in which `construct` is defined. Fails if there is no stack up the tree. ###### `construct`Required - *Type:* constructs.IConstruct The construct to start the search from. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | account | string | The AWS account into which this stack will be deployed. | | artifactId | string | The ID of the cloud assembly artifact for this stack. | | availabilityZones | string[] | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. | | bundlingRequired | boolean | Indicates whether the stack requires bundling or not. | | dependencies | aws-cdk-lib.Stack[] | Return the stacks this stack depends on. | | environment | string | The environment coordinates in which this stack is deployed. | | nested | boolean | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. | | notificationArns | string[] | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. | | partition | string | The partition in which this stack is defined. | | region | string | The AWS region into which this stack will be deployed (e.g. `us-west-2`). | | stackId | string | The ID of the stack. | | stackName | string | The concrete CloudFormation physical stack name. | | synthesizer | aws-cdk-lib.IStackSynthesizer | Synthesis method for this stack. | | tags | aws-cdk-lib.TagManager | Tags to be applied to the stack. | | templateFile | string | The name of the CloudFormation template file emitted to the output directory during synthesis. | | templateOptions | aws-cdk-lib.ITemplateOptions | Options for CloudFormation template (like version, transform, description). | | urlSuffix | string | The Amazon domain suffix for the region in which this stack is defined. | | nestedStackParent | aws-cdk-lib.Stack | If this is a nested stack, returns it's parent stack. | | nestedStackResource | aws-cdk-lib.CfnResource | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. | | terminationProtection | boolean | Whether termination protection is enabled for this stack. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `account`Required ```typescript public readonly account: string; ``` - *Type:* string The AWS account into which this stack will be deployed. This value is resolved according to the following rules: 1. The value provided to `env.account` when the stack is defined. This can either be a concrete account (e.g. `585695031111`) or the `Aws.ACCOUNT_ID` token. 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference `{ "Ref": "AWS::AccountId" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.account)` returns `true`), this implies that the user wishes that this stack will synthesize into a **account-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `artifactId`Required ```typescript public readonly artifactId: string; ``` - *Type:* string The ID of the cloud assembly artifact for this stack. --- ##### `availabilityZones`Required ```typescript public readonly availabilityZones: string[]; ``` - *Type:* string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's `Fn::GetAZs` intrinsic function. If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 `DescribeAvailabilityZones` on the target environment. To specify a different strategy for selecting availability zones override this method. --- ##### `bundlingRequired`Required ```typescript public readonly bundlingRequired: boolean; ``` - *Type:* boolean Indicates whether the stack requires bundling or not. --- ##### `dependencies`Required ```typescript public readonly dependencies: Stack[]; ``` - *Type:* aws-cdk-lib.Stack[] Return the stacks this stack depends on. --- ##### `environment`Required ```typescript public readonly environment: string; ``` - *Type:* string The environment coordinates in which this stack is deployed. In the form `aws://account/region`. Use `stack.account` and `stack.region` to obtain the specific values, no need to parse. You can use this value to determine if two stacks are targeting the same environment. If either `stack.account` or `stack.region` are not concrete values (e.g. `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or `unknown-region` will be used respectively to indicate this stack is region/account-agnostic. --- ##### `nested`Required ```typescript public readonly nested: boolean; ``` - *Type:* boolean Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. --- ##### `notificationArns`Required ```typescript public readonly notificationArns: string[]; ``` - *Type:* string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack. --- ##### `partition`Required ```typescript public readonly partition: string; ``` - *Type:* string The partition in which this stack is defined. --- ##### `region`Required ```typescript public readonly region: string; ``` - *Type:* string The AWS region into which this stack will be deployed (e.g. `us-west-2`). This value is resolved according to the following rules: 1. The value provided to `env.region` when the stack is defined. This can either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION` token. 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference `{ "Ref": "AWS::Region" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.region)` returns `true`), this implies that the user wishes that this stack will synthesize into a **region-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `stackId`Required ```typescript public readonly stackId: string; ``` - *Type:* string The ID of the stack. --- *Example* ```typescript // After resolving, looks like 'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' ``` ##### `stackName`Required ```typescript public readonly stackName: string; ``` - *Type:* string The concrete CloudFormation physical stack name. This is either the name defined explicitly in the `stackName` prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct `id` as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness. If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use `Aws.STACK_NAME` directly. --- ##### `synthesizer`Required ```typescript public readonly synthesizer: IStackSynthesizer; ``` - *Type:* aws-cdk-lib.IStackSynthesizer Synthesis method for this stack. --- ##### `tags`Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tags to be applied to the stack. --- ##### `templateFile`Required ```typescript public readonly templateFile: string; ``` - *Type:* string The name of the CloudFormation template file emitted to the output directory during synthesis. Example value: `MyStack.template.json` --- ##### `templateOptions`Required ```typescript public readonly templateOptions: ITemplateOptions; ``` - *Type:* aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description). --- ##### `urlSuffix`Required ```typescript public readonly urlSuffix: string; ``` - *Type:* string The Amazon domain suffix for the region in which this stack is defined. --- ##### `nestedStackParent`Optional ```typescript public readonly nestedStackParent: Stack; ``` - *Type:* aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack. --- ##### `nestedStackResource`Optional ```typescript public readonly nestedStackResource: CfnResource; ``` - *Type:* aws-cdk-lib.CfnResource If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. `undefined` for top-level (non-nested) stacks. --- ##### `terminationProtection`Optional ```typescript public readonly terminationProtection: boolean; ``` - *Type:* boolean Whether termination protection is enabled for this stack. --- ### IncidentResponse Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#aws-resource-ssmincidents-responseplan-properties. #### Initializers ```typescript import { IncidentResponse } from '@cdklabs/cdk-ssm-documents' new IncidentResponse(scope: Construct, id: string, props: IncidentResponseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | IncidentResponseProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* IncidentResponseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { IncidentResponse } from '@cdklabs/cdk-ssm-documents' IncidentResponse.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnResponsePlan | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnResponsePlan`Required ```typescript public readonly cfnResponsePlan: CfnResponsePlan; ``` - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan --- ### InvokeLambdaFunctionStep AutomationStep implemenation for aws:invokeLambdaFunction https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-lamb.html. #### Initializers ```typescript import { InvokeLambdaFunctionStep } from '@cdklabs/cdk-ssm-documents' new InvokeLambdaFunctionStep(scope: Construct, id: string, props: InvokeLambdaFunctionStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | InvokeLambdaFunctionStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* InvokeLambdaFunctionStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { InvokeLambdaFunctionStep } from '@cdklabs/cdk-ssm-documents' InvokeLambdaFunctionStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | functionName | IStringVariable | *No description.* | | awsInvoker | IAwsInvoker | *No description.* | | clientContext | IStringVariable | *No description.* | | invocationType | IStringVariable | *No description.* | | logType | IStringVariable | *No description.* | | payload | IStringMapVariable | *No description.* | | qualifier | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `functionName`Required ```typescript public readonly functionName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `awsInvoker`Optional ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `clientContext`Optional ```typescript public readonly clientContext: IStringVariable; ``` - *Type:* IStringVariable --- ##### `invocationType`Optional ```typescript public readonly invocationType: IStringVariable; ``` - *Type:* IStringVariable --- ##### `logType`Optional ```typescript public readonly logType: IStringVariable; ``` - *Type:* IStringVariable --- ##### `payload`Optional ```typescript public readonly payload: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `qualifier`Optional ```typescript public readonly qualifier: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### InvokeWebhookStep AutomationStep implementation for [aws:invokeWebhook](https://docs.aws.amazon.com/systems-manager/latest/userguide/invoke-webhook.html). #### Initializers ```typescript import { InvokeWebhookStep } from '@cdklabs/cdk-ssm-documents' new InvokeWebhookStep(scope: Construct, id: string, props: InvokeWebhookStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | InvokeWebhookStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* InvokeWebhookStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { InvokeWebhookStep } from '@cdklabs/cdk-ssm-documents' InvokeWebhookStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | integrationName | IStringVariable | *No description.* | | body | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `integrationName`Required ```typescript public readonly integrationName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `body`Optional ```typescript public readonly body: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### PauseStep AutomationStep implementation for aws:pause https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-pause.html. #### Initializers ```typescript import { PauseStep } from '@cdklabs/cdk-ssm-documents' new PauseStep(scope: Construct, id: string, props: AutomationStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AutomationStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AutomationStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | No inputs required for Pause step. | | listOutputs | No outputs emitted from Pause step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` No inputs required for Pause step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` No outputs emitted from Pause step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { PauseStep } from '@cdklabs/cdk-ssm-documents' PauseStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### PsModuleStep AutomationStep implemenation for aws:psmodule https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-psModule. #### Initializers ```typescript import { PsModuleStep } from '@cdklabs/cdk-ssm-documents' new PsModuleStep(scope: Construct, id: string, props: PsModuleStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PsModuleStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* PsModuleStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command includes both the runCommand variables and workingDirectory if provided. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command includes both the runCommand variables and workingDirectory if provided. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { PsModuleStep } from '@cdklabs/cdk-ssm-documents' PsModuleStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | source | IStringVariable | *No description.* | | runCommand | IStringVariable[] | *No description.* | | sourceHash | IStringVariable | *No description.* | | timeoutSeconds | number | *No description.* | | workingDirectory | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable --- ##### `runCommand`Optional ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] --- ##### `sourceHash`Optional ```typescript public readonly sourceHash: IStringVariable; ``` - *Type:* IStringVariable --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable --- ### RebootInstanceAndWait #### Initializers ```typescript import { RebootInstanceAndWait } from '@cdklabs/cdk-ssm-documents' new RebootInstanceAndWait(scope: Construct, id: string, instanceId: IStringVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | instanceId | IStringVariable | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `instanceId`Required - *Type:* IStringVariable --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addToDocument | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RebootInstanceAndWait } from '@cdklabs/cdk-ssm-documents' RebootInstanceAndWait.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | describe | WaitForResourceStep | *No description.* | | reboot | AwsApiStep | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `describe`Required ```typescript public readonly describe: WaitForResourceStep; ``` - *Type:* WaitForResourceStep --- ##### `reboot`Required ```typescript public readonly reboot: AwsApiStep; ``` - *Type:* AwsApiStep --- ### RunCommandStep AutomationStep implementation of [aws:runCommand](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-runcommand.html). #### Initializers ```typescript import { RunCommandStep } from '@cdklabs/cdk-ssm-documents' new RunCommandStep(scope: Construct, id: string, props: RunCommandStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunCommandStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunCommandStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunCommandStep } from '@cdklabs/cdk-ssm-documents' RunCommandStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | documentName | IStringVariable | *No description.* | | targets | IStringListVariable \| IMapListVariable | *No description.* | | cloudWatchOutputConfig | IStringMapVariable | *No description.* | | commandTimeoutSeconds | INumberVariable | *No description.* | | comment | IStringVariable | *No description.* | | documentHash | IStringVariable | *No description.* | | documentHashType | IDocumentHashTypeVariable | *No description.* | | maxConcurrency | INumberVariable | *No description.* | | maxErrors | INumberVariable | *No description.* | | notificationConfig | IStringMapVariable | *No description.* | | outputS3BucketName | IStringVariable | *No description.* | | outputS3KeyPrefix | IStringVariable | *No description.* | | parameters | IStringMapVariable | *No description.* | | serviceRoleArn | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `documentName`Required ```typescript public readonly documentName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `targets`Required ```typescript public readonly targets: IStringListVariable | IMapListVariable; ``` - *Type:* IStringListVariable | IMapListVariable --- ##### `cloudWatchOutputConfig`Optional ```typescript public readonly cloudWatchOutputConfig: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `commandTimeoutSeconds`Optional ```typescript public readonly commandTimeoutSeconds: INumberVariable; ``` - *Type:* INumberVariable --- ##### `comment`Optional ```typescript public readonly comment: IStringVariable; ``` - *Type:* IStringVariable --- ##### `documentHash`Optional ```typescript public readonly documentHash: IStringVariable; ``` - *Type:* IStringVariable --- ##### `documentHashType`Optional ```typescript public readonly documentHashType: IDocumentHashTypeVariable; ``` - *Type:* IDocumentHashTypeVariable --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: INumberVariable; ``` - *Type:* INumberVariable --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: INumberVariable; ``` - *Type:* INumberVariable --- ##### `notificationConfig`Optional ```typescript public readonly notificationConfig: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `outputS3BucketName`Optional ```typescript public readonly outputS3BucketName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `outputS3KeyPrefix`Optional ```typescript public readonly outputS3KeyPrefix: IStringVariable; ``` - *Type:* IStringVariable --- ##### `parameters`Optional ```typescript public readonly parameters: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `serviceRoleArn`Optional ```typescript public readonly serviceRoleArn: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### RunDockerActionStep CommandStep implementation for aws:runDockerAction https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-rundockeraction. #### Initializers ```typescript import { RunDockerActionStep } from '@cdklabs/cdk-ssm-documents' new RunDockerActionStep(scope: Construct, id: string, props: RunDockerActionStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunDockerActionStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunDockerActionStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunDockerActionStep } from '@cdklabs/cdk-ssm-documents' RunDockerActionStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | dockerAction | IStringVariable | *No description.* | | cmd | IStringVariable | *No description.* | | container | IStringVariable | *No description.* | | cpuShares | IStringVariable | *No description.* | | env | IStringVariable | *No description.* | | image | IStringVariable | *No description.* | | memory | IStringVariable | *No description.* | | publish | IStringVariable | *No description.* | | user | IStringVariable | *No description.* | | volume | IStringListVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `dockerAction`Required ```typescript public readonly dockerAction: IStringVariable; ``` - *Type:* IStringVariable --- ##### `cmd`Optional ```typescript public readonly cmd: IStringVariable; ``` - *Type:* IStringVariable --- ##### `container`Optional ```typescript public readonly container: IStringVariable; ``` - *Type:* IStringVariable --- ##### `cpuShares`Optional ```typescript public readonly cpuShares: IStringVariable; ``` - *Type:* IStringVariable --- ##### `env`Optional ```typescript public readonly env: IStringVariable; ``` - *Type:* IStringVariable --- ##### `image`Optional ```typescript public readonly image: IStringVariable; ``` - *Type:* IStringVariable --- ##### `memory`Optional ```typescript public readonly memory: IStringVariable; ``` - *Type:* IStringVariable --- ##### `publish`Optional ```typescript public readonly publish: IStringVariable; ``` - *Type:* IStringVariable --- ##### `user`Optional ```typescript public readonly user: IStringVariable; ``` - *Type:* IStringVariable --- ##### `volume`Optional ```typescript public readonly volume: IStringListVariable; ``` - *Type:* IStringListVariable --- ### RunDocumentStep CommandStep implementation for aws:runDocument https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-rundocument. #### Initializers ```typescript import { RunDocumentStep } from '@cdklabs/cdk-ssm-documents' new RunDocumentStep(scope: Construct, id: string, props: RunDocumentStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunDocumentStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunDocumentStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunDocumentStep } from '@cdklabs/cdk-ssm-documents' RunDocumentStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | stepDocument | IRunDocumentLocation | *No description.* | | documentParameters | IStringMapVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `stepDocument`Required ```typescript public readonly stepDocument: IRunDocumentLocation; ``` - *Type:* IRunDocumentLocation --- ##### `documentParameters`Optional ```typescript public readonly documentParameters: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ### RunInstanceStep AutomationStep implemenation for aws:runInstance https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-runinstance.html. #### Initializers ```typescript import { RunInstanceStep } from '@cdklabs/cdk-ssm-documents' new RunInstanceStep(scope: Construct, id: string, props: RunInstanceStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunInstanceStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunInstanceStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Derives the inputs based on given variables. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Derives the inputs based on given variables. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunInstanceStep } from '@cdklabs/cdk-ssm-documents' RunInstanceStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | imageId | IStringVariable | *No description.* | | additionalInfo | IStringVariable | *No description.* | | blockDeviceMappings | IMapListVariable | *No description.* | | clientToken | IStringVariable | *No description.* | | disableApiTermination | IBooleanVariable | *No description.* | | ebsOptimized | IBooleanVariable | *No description.* | | iamInstanceProfileArn | IStringVariable | *No description.* | | iamInstanceProfileName | IStringVariable | *No description.* | | instanceInitiatedShutdownBehavior | IStringVariable | *No description.* | | instanceType | IStringVariable | *No description.* | | kernelId | IStringVariable | *No description.* | | keyName | IStringVariable | *No description.* | | maxInstanceCount | INumberVariable | *No description.* | | minInstanceCount | INumberVariable | *No description.* | | monitoring | IBooleanVariable | *No description.* | | networkInterfaces | IMapListVariable | *No description.* | | placement | IStringMapVariable | *No description.* | | privateIpAddress | IStringVariable | *No description.* | | ramdiskId | IStringVariable | *No description.* | | securityGroupIds | IStringListVariable | *No description.* | | securityGroups | IStringListVariable | *No description.* | | subnetId | IStringVariable | *No description.* | | tagSpecifications | IMapListVariable | *No description.* | | userData | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `imageId`Required ```typescript public readonly imageId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `additionalInfo`Optional ```typescript public readonly additionalInfo: IStringVariable; ``` - *Type:* IStringVariable --- ##### `blockDeviceMappings`Optional ```typescript public readonly blockDeviceMappings: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `clientToken`Optional ```typescript public readonly clientToken: IStringVariable; ``` - *Type:* IStringVariable --- ##### `disableApiTermination`Optional ```typescript public readonly disableApiTermination: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `ebsOptimized`Optional ```typescript public readonly ebsOptimized: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `iamInstanceProfileArn`Optional ```typescript public readonly iamInstanceProfileArn: IStringVariable; ``` - *Type:* IStringVariable --- ##### `iamInstanceProfileName`Optional ```typescript public readonly iamInstanceProfileName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `instanceInitiatedShutdownBehavior`Optional ```typescript public readonly instanceInitiatedShutdownBehavior: IStringVariable; ``` - *Type:* IStringVariable --- ##### `instanceType`Optional ```typescript public readonly instanceType: IStringVariable; ``` - *Type:* IStringVariable --- ##### `kernelId`Optional ```typescript public readonly kernelId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `keyName`Optional ```typescript public readonly keyName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `maxInstanceCount`Optional ```typescript public readonly maxInstanceCount: INumberVariable; ``` - *Type:* INumberVariable --- ##### `minInstanceCount`Optional ```typescript public readonly minInstanceCount: INumberVariable; ``` - *Type:* INumberVariable --- ##### `monitoring`Optional ```typescript public readonly monitoring: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `networkInterfaces`Optional ```typescript public readonly networkInterfaces: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `placement`Optional ```typescript public readonly placement: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `privateIpAddress`Optional ```typescript public readonly privateIpAddress: IStringVariable; ``` - *Type:* IStringVariable --- ##### `ramdiskId`Optional ```typescript public readonly ramdiskId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `securityGroupIds`Optional ```typescript public readonly securityGroupIds: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `securityGroups`Optional ```typescript public readonly securityGroups: IStringListVariable; ``` - *Type:* IStringListVariable --- ##### `subnetId`Optional ```typescript public readonly subnetId: IStringVariable; ``` - *Type:* IStringVariable --- ##### `tagSpecifications`Optional ```typescript public readonly tagSpecifications: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `userData`Optional ```typescript public readonly userData: IStringVariable; ``` - *Type:* IStringVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### RunPowerShellScriptStep AutomationStep implementation for aws:runPowerShellScript https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-runPowerShellScript. #### Initializers ```typescript import { RunPowerShellScriptStep } from '@cdklabs/cdk-ssm-documents' new RunPowerShellScriptStep(scope: Construct, id: string, props: RunPowerShellScriptStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunPowerShellScriptStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunPowerShellScriptStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command includes both the runCommand variables and workingDirectory if provided. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command includes both the runCommand variables and workingDirectory if provided. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunPowerShellScriptStep } from '@cdklabs/cdk-ssm-documents' RunPowerShellScriptStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | runCommand | IStringVariable[] | *No description.* | | timeoutSeconds | number | *No description.* | | workingDirectory | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `runCommand`Required ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable --- ### RunShellScriptStep AutomationStep implemenation for aws:sleep https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-sleep.html. #### Initializers ```typescript import { RunShellScriptStep } from '@cdklabs/cdk-ssm-documents' new RunShellScriptStep(scope: Construct, id: string, props: RunShellScriptStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RunShellScriptStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* RunShellScriptStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command includes both the runCommand variables and workingDirectory if provided. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command includes both the runCommand variables and workingDirectory if provided. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RunShellScriptStep } from '@cdklabs/cdk-ssm-documents' RunShellScriptStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | runCommand | IStringVariable[] | *No description.* | | timeoutSeconds | number | *No description.* | | workingDirectory | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `runCommand`Required ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable --- ### SleepStep AutomationStep implemenation for aws:sleep https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-sleep.html. #### Initializers ```typescript import { SleepStep } from '@cdklabs/cdk-ssm-documents' new SleepStep(scope: Construct, id: string, props: SleepStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SleepStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* SleepStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | No inputs required for Sleep step. | | listOutputs | No outputs emitted from Sleep step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` No inputs required for Sleep step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` No outputs emitted from Sleep step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { SleepStep } from '@cdklabs/cdk-ssm-documents' SleepStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | sleepSeconds | number | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `sleepSeconds`Required ```typescript public readonly sleepSeconds: number; ``` - *Type:* number --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ### SoftwareInventoryStep AutomationStep implemenation for aws:softwareInventory https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-softwareinventory. #### Initializers ```typescript import { SoftwareInventoryStep } from '@cdklabs/cdk-ssm-documents' new SoftwareInventoryStep(scope: Construct, id: string, props: SoftwareInventoryStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SoftwareInventoryStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* SoftwareInventoryStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | All Inputs for this command are optional. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` All Inputs for this command are optional. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { SoftwareInventoryStep } from '@cdklabs/cdk-ssm-documents' SoftwareInventoryStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | applications | IStringVariable | *No description.* | | awsComponents | IStringVariable | *No description.* | | customInventory | IStringVariable | *No description.* | | files | IStringVariable | *No description.* | | instanceDetailedInformation | IStringVariable | *No description.* | | networkConfig | IStringVariable | *No description.* | | services | IStringVariable | *No description.* | | windowsRegistry | IStringVariable | *No description.* | | windowsRoles | IStringVariable | *No description.* | | windowsUpdates | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `applications`Optional ```typescript public readonly applications: IStringVariable; ``` - *Type:* IStringVariable --- ##### `awsComponents`Optional ```typescript public readonly awsComponents: IStringVariable; ``` - *Type:* IStringVariable --- ##### `customInventory`Optional ```typescript public readonly customInventory: IStringVariable; ``` - *Type:* IStringVariable --- ##### `files`Optional ```typescript public readonly files: IStringVariable; ``` - *Type:* IStringVariable --- ##### `instanceDetailedInformation`Optional ```typescript public readonly instanceDetailedInformation: IStringVariable; ``` - *Type:* IStringVariable --- ##### `networkConfig`Optional ```typescript public readonly networkConfig: IStringVariable; ``` - *Type:* IStringVariable --- ##### `services`Optional ```typescript public readonly services: IStringVariable; ``` - *Type:* IStringVariable --- ##### `windowsRegistry`Optional ```typescript public readonly windowsRegistry: IStringVariable; ``` - *Type:* IStringVariable --- ##### `windowsRoles`Optional ```typescript public readonly windowsRoles: IStringVariable; ``` - *Type:* IStringVariable --- ##### `windowsUpdates`Optional ```typescript public readonly windowsUpdates: IStringVariable; ``` - *Type:* IStringVariable --- ### SsmDocument #### Initializers ```typescript import { SsmDocument } from '@cdklabs/cdk-ssm-documents' new SsmDocument(scope: Construct, id: string, props: SsmDocumentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SsmDocumentProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* SsmDocumentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | documentType | *No description.* | | print | Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `documentType` ```typescript public documentType(): string ``` ##### `print` ```typescript public print(): string ``` Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); Converts the objects define in the SSM Document (including all of the steps) to an SSM document string. The format is dependency on the documentFormat property provided to the class. The yaml can be used as is and will behave (or at least should behave) as was simulated in the runSimulation(). #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { SsmDocument } from '@cdklabs/cdk-ssm-documents' SsmDocument.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnDocument | aws-cdk-lib.aws_ssm.CfnDocument | *No description.* | | description | string | *No description.* | | docInputs | Input[] | *No description.* | | docOutputs | DocumentOutput[] | *No description.* | | documentName | string | *No description.* | | props | SsmDocumentProps | *No description.* | | assumeRole | IStringVariable | *No description.* | | header | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnDocument`Required ```typescript public readonly cfnDocument: CfnDocument; ``` - *Type:* aws-cdk-lib.aws_ssm.CfnDocument --- ##### `description`Required ```typescript public readonly description: string; ``` - *Type:* string --- ##### `docInputs`Required ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] --- ##### `docOutputs`Required ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string --- ##### `props`Required ```typescript public readonly props: SsmDocumentProps; ``` - *Type:* SsmDocumentProps --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string --- ### Step #### Initializers ```typescript import { Step } from '@cdklabs/cdk-ssm-documents' new Step(scope: Construct, id: string, props: StepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | StepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* StepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Lists the inputs that are required for this step. | | listOutputs | Lists the outputs that will be returned from this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Lists the inputs that are required for this step. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` Lists the outputs that will be returned from this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Step } from '@cdklabs/cdk-ssm-documents' Step.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ### StringStep StringStep allows for including a step from an existing automation document verbatim. This is useful in that it allows developers to integrate with existing document steps. This step can be used just as you would use any other Step including simulation and deployment. #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addToDocument | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromJson | Builds a step object from a json declaration. | | fromObject | Builds a step object from an object. | | fromYaml | Builds a step object from a yaml declaration. | --- ##### ~~`isConstruct`~~ ```typescript import { StringStep } from '@cdklabs/cdk-ssm-documents' StringStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- ##### `fromJson` ```typescript import { StringStep } from '@cdklabs/cdk-ssm-documents' StringStep.fromJson(scope: Construct, json: string) ``` Builds a step object from a json declaration. You may cast the step afterword to the associated Step for this action if you wish to gain access to action specific functionality, ###### `scope`Required - *Type:* constructs.Construct --- ###### `json`Required - *Type:* string --- ##### `fromObject` ```typescript import { StringStep } from '@cdklabs/cdk-ssm-documents' StringStep.fromObject(scope: Construct, props: {[ key: string ]: any}) ``` Builds a step object from an object. You may cast the step afterword to the associated Step for this action if you wish to gain access to action specific functionality, ###### `scope`Required - *Type:* constructs.Construct --- ###### `props`Required - *Type:* {[ key: string ]: any} --- ##### `fromYaml` ```typescript import { StringStep } from '@cdklabs/cdk-ssm-documents' StringStep.fromYaml(scope: Construct, inputYaml: string) ``` Builds a step object from a yaml declaration. You may cast the step afterword to the associated Step for this action if you wish to gain access to action specific functionality, ###### `scope`Required - *Type:* constructs.Construct --- ###### `inputYaml`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### TimedDocument #### Initializers ```typescript import { TimedDocument } from '@cdklabs/cdk-ssm-documents' new TimedDocument(stage: Construct, id: string, props: AutomationDocumentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | stage | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AutomationDocumentProps | *No description.* | --- ##### `stage`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* AutomationDocumentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | documentType | *No description.* | | print | Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); | | addStep | *No description.* | | collectedSteps | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `documentType` ```typescript public documentType(): string ``` ##### `print` ```typescript public print(): string ``` Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack); Converts the objects define in the SSM Document (including all of the steps) to an SSM document string. The format is dependency on the documentFormat property provided to the class. The yaml can be used as is and will behave (or at least should behave) as was simulated in the runSimulation(). ##### `addStep` ```typescript public addStep(component: IAutomationComponent): void ``` ###### `component`Required - *Type:* IAutomationComponent --- ##### `collectedSteps` ```typescript public collectedSteps(): AutomationStep[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { TimedDocument } from '@cdklabs/cdk-ssm-documents' TimedDocument.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | cfnDocument | aws-cdk-lib.aws_ssm.CfnDocument | *No description.* | | description | string | *No description.* | | docInputs | Input[] | *No description.* | | docOutputs | DocumentOutput[] | *No description.* | | documentName | string | *No description.* | | props | SsmDocumentProps | *No description.* | | assumeRole | IStringVariable | *No description.* | | header | string | *No description.* | | builder | AutomationDocumentBuilder | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `cfnDocument`Required ```typescript public readonly cfnDocument: CfnDocument; ``` - *Type:* aws-cdk-lib.aws_ssm.CfnDocument --- ##### `description`Required ```typescript public readonly description: string; ``` - *Type:* string --- ##### `docInputs`Required ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] --- ##### `docOutputs`Required ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string --- ##### `props`Required ```typescript public readonly props: SsmDocumentProps; ``` - *Type:* SsmDocumentProps --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string --- ##### `builder`Required ```typescript public readonly builder: AutomationDocumentBuilder; ``` - *Type:* AutomationDocumentBuilder --- ### UpdateAgentStep CommandStep implementation for aws:UpdateAgent https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-updateagent. #### Initializers ```typescript import { UpdateAgentStep } from '@cdklabs/cdk-ssm-documents' new UpdateAgentStep(scope: Construct, id: string, props: UpdateAgentStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | UpdateAgentStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* UpdateAgentStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { UpdateAgentStep } from '@cdklabs/cdk-ssm-documents' UpdateAgentStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | agentName | IStringVariable | *No description.* | | source | IStringVariable | *No description.* | | allowDowngrade | IBooleanVariable | *No description.* | | targetVersion | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `agentName`Required ```typescript public readonly agentName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable --- ##### `allowDowngrade`Optional ```typescript public readonly allowDowngrade: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `targetVersion`Optional ```typescript public readonly targetVersion: IStringVariable; ``` - *Type:* IStringVariable --- ### UpdateSSMAgentStep AutomationStep implemenation for aws:UpdateSsmAgent https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-updatessmagent. #### Initializers ```typescript import { UpdateSSMAgentStep } from '@cdklabs/cdk-ssm-documents' new UpdateSSMAgentStep(scope: Construct, id: string, props: UpdateSSMAgentStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | UpdateSSMAgentStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* UpdateSSMAgentStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. | | listOutputs | RunCommand Steps do not have outputs. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Inputs required for this command include agentName allowDowngrade source and targetVersion if version other than latest is desired. ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` RunCommand Steps do not have outputs. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { UpdateSSMAgentStep } from '@cdklabs/cdk-ssm-documents' UpdateSSMAgentStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | exitOnFailure | boolean | *No description.* | | exitOnSuccess | boolean | *No description.* | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | platforms | Platform[] | *No description.* | | precondition | Precondition | *No description.* | | allStepsInExecution | CommandStep[] | *No description.* | | nextStep | CommandStep | *No description.* | | agentName | IStringVariable | *No description.* | | allowDowngrade | IBooleanVariable | *No description.* | | source | IStringVariable | *No description.* | | targetVersion | IStringVariable | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `exitOnFailure`Required ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean --- ##### `exitOnSuccess`Required ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean --- ##### `finallyStep`Required ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Required ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `platforms`Required ```typescript public readonly platforms: Platform[]; ``` - *Type:* Platform[] --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: CommandStep[]; ``` - *Type:* CommandStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: CommandStep; ``` - *Type:* CommandStep --- ##### `agentName`Required ```typescript public readonly agentName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `allowDowngrade`Required ```typescript public readonly allowDowngrade: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable --- ##### `targetVersion`Optional ```typescript public readonly targetVersion: IStringVariable; ``` - *Type:* IStringVariable --- ### WaitForResourceStep AutomationStep impl for aws:waitForAwsResourceProperty https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-waitForAwsResourceProperty.html. #### Initializers ```typescript import { WaitForResourceStep } from '@cdklabs/cdk-ssm-documents' new WaitForResourceStep(scope: Construct, id: string, props: WaitForResourceStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | WaitForResourceStepProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Required - *Type:* WaitForResourceStepProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | listInputs | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). | | listOutputs | There are no outputs for this step. | | toSsmEntry | Converts this step into an object to prepare for yaml/json representation of this step. | | addToDocument | *No description.* | | listUserOutputs | Lists the outputs defined by the user for this step. | | variables | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `listInputs` ```typescript public listInputs(): string[] ``` Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). ##### `listOutputs` ```typescript public listOutputs(): Output[] ``` There are no outputs for this step. ##### `toSsmEntry` ```typescript public toSsmEntry(): {[ key: string ]: any} ``` Converts this step into an object to prepare for yaml/json representation of this step. ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ##### `listUserOutputs` ```typescript public listUserOutputs(): Output[] ``` Lists the outputs defined by the user for this step. ##### `variables` ```typescript public variables(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { WaitForResourceStep } from '@cdklabs/cdk-ssm-documents' WaitForResourceStep.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | action | string | *No description.* | | inputObserver | IObserver | *No description.* | | name | string | *No description.* | | outputObserver | IObserver | *No description.* | | description | string | *No description.* | | isEnd | boolean | *No description.* | | maxAttempts | number | *No description.* | | onCancel | OnCancel | *No description.* | | onFailure | OnFailure | *No description.* | | timeoutSeconds | number | *No description.* | | explicitNextStep | StepRef | *No description.* | | allStepsInExecution | AutomationStep[] | *No description.* | | nextStep | AutomationStep | *No description.* | | apiParams | DictFormat | *No description.* | | javaScriptApi | string | *No description.* | | outputs | Output[] | *No description.* | | pascalCaseApi | string | *No description.* | | service | AwsService | *No description.* | | desiredValues | string[] | *No description.* | | selector | string | *No description.* | | sleepIntervalMillis | number | *No description.* | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `isEnd`Required ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean --- ##### `maxAttempts`Required ```typescript public readonly maxAttempts: number; ``` - *Type:* number --- ##### `onCancel`Required ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel --- ##### `onFailure`Required ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure --- ##### `timeoutSeconds`Required ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef --- ##### `allStepsInExecution`Optional ```typescript public readonly allStepsInExecution: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ##### `nextStep`Optional ```typescript public readonly nextStep: AutomationStep; ``` - *Type:* AutomationStep --- ##### `apiParams`Required ```typescript public readonly apiParams: DictFormat; ``` - *Type:* DictFormat --- ##### `javaScriptApi`Required ```typescript public readonly javaScriptApi: string; ``` - *Type:* string --- ##### `outputs`Required ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] --- ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string --- ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService --- ##### `desiredValues`Required ```typescript public readonly desiredValues: string[]; ``` - *Type:* string[] --- ##### `selector`Required ```typescript public readonly selector: string; ``` - *Type:* string --- ##### `sleepIntervalMillis`Required ```typescript public readonly sleepIntervalMillis: number; ``` - *Type:* number --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_MAX_ATTEMPTS | number | *No description.* | | DEFAULT_TIMEOUT | number | *No description.* | --- ##### `DEFAULT_MAX_ATTEMPTS`Required ```typescript public readonly DEFAULT_MAX_ATTEMPTS: number; ``` - *Type:* number --- ##### `DEFAULT_TIMEOUT`Required ```typescript public readonly DEFAULT_TIMEOUT: number; ``` - *Type:* number --- ## Structs ### ApiExecuteAutomationProps #### Initializer ```typescript import { ApiExecuteAutomationProps } from '@cdklabs/cdk-ssm-documents' const apiExecuteAutomationProps: ApiExecuteAutomationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | *No description.* | | sleepHook | ISleepHook | *No description.* | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook --- ### ApiRunCommandProps #### Initializer ```typescript import { ApiRunCommandProps } from '@cdklabs/cdk-ssm-documents' const apiRunCommandProps: ApiRunCommandProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | *No description.* | | sleepHook | ISleepHook | *No description.* | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook --- ### ApplicationsStepProps #### Initializer ```typescript import { ApplicationsStepProps } from '@cdklabs/cdk-ssm-documents' const applicationsStepProps: ApplicationsStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | action | IInstallUninstallRepairVariable | *No description.* | | source | IStringVariable | *No description.* | | parameters | IStringVariable | *No description.* | | sourceHash | IStringVariable | *No description.* | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `action`Required ```typescript public readonly action: IInstallUninstallRepairVariable; ``` - *Type:* IInstallUninstallRepairVariable --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable --- ##### `parameters`Optional ```typescript public readonly parameters: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceHash`Optional ```typescript public readonly sourceHash: IStringVariable; ``` - *Type:* IStringVariable --- ### ApproveSimulationProps Properties for ApproveStep. #### Initializer ```typescript import { ApproveSimulationProps } from '@cdklabs/cdk-ssm-documents' const approveSimulationProps: ApproveSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approveHook | IApproveHook | (Optional) Approve hook to be called to pause the execution. | --- ##### `approveHook`Required ```typescript public readonly approveHook: IApproveHook; ``` - *Type:* IApproveHook - *Default:* ApproveHook instance. ApproveHook may not work in exported JSII languages. Override interface as needed. (Optional) Approve hook to be called to pause the execution. To mock this implementation either inject an instance of IApproveHook or use the provided MockApprove class. --- ### ApproveStepProps Properties for ApproveStep. #### Initializer ```typescript import { ApproveStepProps } from '@cdklabs/cdk-ssm-documents' const approveStepProps: ApproveStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | approvers | IStringListVariable | A list of AWS authenticated principals who are able to either approve or reject the action. | | message | IStringVariable | (Optional) The information you want to include in the Amazon SNS topic when the approval request is sent. | | minRequiredApprovals | INumberVariable | (Optional) The minimum number of approvals required to resume the automation. | | notificationArn | IStringVariable | (Optional) The Amazon Resource Name (ARN of an Amazon Simple Notification Service (Amazon SNS) topic for Automation approvals. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `approvers`Required ```typescript public readonly approvers: IStringListVariable; ``` - *Type:* IStringListVariable A list of AWS authenticated principals who are able to either approve or reject the action. The maximum number of approvers is 10. You can specify principals by using any of the following formats: * An AWS Identity and Access Management (IAM) user name * An IAM user ARN * An IAM role ARN * An IAM assume role user ARN --- ##### `message`Optional ```typescript public readonly message: IStringVariable; ``` - *Type:* IStringVariable (Optional) The information you want to include in the Amazon SNS topic when the approval request is sent. The maximum message length is 4096 characters. --- ##### `minRequiredApprovals`Optional ```typescript public readonly minRequiredApprovals: INumberVariable; ``` - *Type:* INumberVariable (Optional) The minimum number of approvals required to resume the automation. If you don't specify a value, the system defaults to one. The value for this parameter must be a positive number. The value for this parameter can't exceed the number of approvers defined by the Approvers parameter. --- ##### `notificationArn`Optional ```typescript public readonly notificationArn: IStringVariable; ``` - *Type:* IStringVariable (Optional) The Amazon Resource Name (ARN of an Amazon Simple Notification Service (Amazon SNS) topic for Automation approvals. When you specify an aws:approve step in a runbook, Automation sends a message to this topic letting principals know that they must either approve or reject an Automation step. The title of the Amazon SNS topic must be prefixed with "Automation". --- ### AssertAwsResourceStepProps Properties for AssertAwsResourceStep. #### Initializer ```typescript import { AssertAwsResourceStepProps } from '@cdklabs/cdk-ssm-documents' const assertAwsResourceStepProps: AssertAwsResourceStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | apiParams | {[ key: string ]: any} | (Required) API Params to submit with the request to the api. | | pascalCaseApi | string | (Required) The AWS api represented in PascalCase. | | service | AwsService | (Required) The AWS service to be invoked. | | javaScriptApi | string | (Optional) The api as represented the AWS JavaScript API. | | desiredValues | string[] | (Required) Value extracted from AWS response desired to be one of these desired values. | | selector | string | (Required) Json path selector to extract value from AWS response. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `apiParams`Required ```typescript public readonly apiParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Required) API Params to submit with the request to the api. You may include variables which will be substitued for inputs during step execution as such {{ INPUT }} --- *Example* ```typescript { 'VolumeIds': ['{{ EbsDescribeInstance.VolumeId }}'] } ``` ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string (Required) The AWS api represented in PascalCase. This value is used as-is in the SSM yaml/json. This is used as the default for javaScriptApi (see that param). --- *Example* ```typescript DescribeInstances ``` ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService (Required) The AWS service to be invoked. --- *Example* ```typescript AwsService.S3 ``` ##### `javaScriptApi`Optional ```typescript public readonly javaScriptApi: string; ``` - *Type:* string - *Default:* will use the camelCaseApi param and substitute the first character for lowercase by default. (Optional) The api as represented the AWS JavaScript API. This is usually lowerCamelCase. This is used in the simulation run to execute the AWS API against the JavaScript SDK. --- *Example* ```typescript describeInstances ``` ##### `desiredValues`Required ```typescript public readonly desiredValues: string[]; ``` - *Type:* string[] (Required) Value extracted from AWS response desired to be one of these desired values. --- ##### `selector`Required ```typescript public readonly selector: string; ``` - *Type:* string (Required) Json path selector to extract value from AWS response. --- ### AutomationDocumentProps Options for AutomationDocument. #### Initializer ```typescript import { AutomationDocumentProps } from '@cdklabs/cdk-ssm-documents' const automationDocumentProps: AutomationDocumentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assumeRole | IStringVariable | (Optional) Assume role to use for this document. | | description | string | (Optional) Description of the document. | | docInputs | Input[] | (Optional) Inputs required by the document. | | docOutputs | DocumentOutput[] | (Optional) Outputs to be emitted from the document. | | documentFormat | DocumentFormat | (Optional) Specifies whether this document should be written as YAML or JSON. | | documentName | string | (Optional) Name of the document. | | header | string | (Optional) A Header/comment to include at the start of a YAML document. | | requires | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty \| aws-cdk-lib.IResolvable[] | `AWS::SSM::Document.Requires`. | | tags | aws-cdk-lib.CfnTag[] | `AWS::SSM::Document.Tags`. | | targetType | string | `AWS::SSM::Document.TargetType`. | | updateMethod | string | If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. | | versionName | string | `AWS::SSM::Document.VersionName`. | --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable (Optional) Assume role to use for this document. If provided, this value MUST be included as one of the documentInput names. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string (Optional) Description of the document. Defaults to the document name. --- ##### `docInputs`Optional ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] (Optional) Inputs required by the document. --- ##### `docOutputs`Optional ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] - *Default:* [] (Optional) Outputs to be emitted from the document. The outputs are placed in a StringSet called outputs (as is done in SSM). --- ##### `documentFormat`Optional ```typescript public readonly documentFormat: DocumentFormat; ``` - *Type:* DocumentFormat - *Default:* JSON (Optional) Specifies whether this document should be written as YAML or JSON. --- ##### `documentName`Optional ```typescript public readonly documentName: string; ``` - *Type:* string (Optional) Name of the document. Will default to the id provided for the CDK node. --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string (Optional) A Header/comment to include at the start of a YAML document. JSON documents do not support headers. --- ##### `requires`Optional ```typescript public readonly requires: IResolvable | DocumentRequiresProperty | IResolvable[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty | aws-cdk-lib.IResolvable[] `AWS::SSM::Document.Requires`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires) --- ##### `tags`Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] `AWS::SSM::Document.Tags`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags) --- ##### `targetType`Optional ```typescript public readonly targetType: string; ``` - *Type:* string `AWS::SSM::Document.TargetType`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype) --- ##### `updateMethod`Optional ```typescript public readonly updateMethod: string; ``` - *Type:* string If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod) --- ##### `versionName`Optional ```typescript public readonly versionName: string; ``` - *Type:* string `AWS::SSM::Document.VersionName`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname) --- ### AutomationSimulationProps #### Initializer ```typescript import { AutomationSimulationProps } from '@cdklabs/cdk-ssm-documents' const automationSimulationProps: AutomationSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approveHook | IApproveHook | (Optional) Approve hook to be called to pause the execution. | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | | executeAutomationHook | IExecuteAutomationHook | Hook for simulating aws:executeAutomation. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | parameterResolver | IParameterResolver | (Optional) Resolver for secure strings in parameters. | | pauseHook | IPauseHook | (Optional) Pause hook to be called to pause the execution. | | runCommandHook | IRunCommandHook | Hook for simulating aws:runCommand. | | sleepHook | ISleepHook | (Optional) Hook to inject alternate ISleeper (to mock the sleep between failed invocations). | | webhook | IWebhook | (Optional) Hook for simulating aws:invokeWebhook. | --- ##### `approveHook`Optional ```typescript public readonly approveHook: IApproveHook; ``` - *Type:* IApproveHook - *Default:* ApproveHook instance. ApproveHook may not work in exported JSII languages. Override interface as needed. (Optional) Approve hook to be called to pause the execution. To mock this implementation either inject an instance of IApproveHook or use the provided MockApprove class. --- ##### `awsInvoker`Optional ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ##### `executeAutomationHook`Optional ```typescript public readonly executeAutomationHook: IExecuteAutomationHook; ``` - *Type:* IExecuteAutomationHook - *Default:* Uses AWS API to execute the document remotely. Hook for simulating aws:executeAutomation. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `parameterResolver`Optional ```typescript public readonly parameterResolver: IParameterResolver; ``` - *Type:* IParameterResolver - *Default:* Treats parameters as literal (Optional) Resolver for secure strings in parameters. Required to simulate if using tokens in parameters input. --- ##### `pauseHook`Optional ```typescript public readonly pauseHook: IPauseHook; ``` - *Type:* IPauseHook - *Default:* PauseHook instance. PauseHook may not work in exported JSII languages. Override interface as needed. (Optional) Pause hook to be called to pause the execution. To mock this implemenation either inject an instance of IPauseHook or use the provided MockPause class. --- ##### `runCommandHook`Optional ```typescript public readonly runCommandHook: IRunCommandHook; ``` - *Type:* IRunCommandHook - *Default:* Uses AWS API to execute the document remotely. Hook for simulating aws:runCommand. --- ##### `sleepHook`Optional ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* really perform sleep using SleeperImpl class. (Optional) Hook to inject alternate ISleeper (to mock the sleep between failed invocations). --- ##### `webhook`Optional ```typescript public readonly webhook: IWebhook; ``` - *Type:* IWebhook - *Default:* Returns 204 with an empty response (Optional) Hook for simulating aws:invokeWebhook. --- ### AutomationStepProps #### Initializer ```typescript import { AutomationStepProps } from '@cdklabs/cdk-ssm-documents' const automationStepProps: AutomationStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ### AwsApiStepProps Properties for AwsInvocation. #### Initializer ```typescript import { AwsApiStepProps } from '@cdklabs/cdk-ssm-documents' const awsApiStepProps: AwsApiStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | apiParams | {[ key: string ]: any} | (Required) API Params to submit with the request to the api. | | pascalCaseApi | string | (Required) The AWS api represented in PascalCase. | | service | AwsService | (Required) The AWS service to be invoked. | | javaScriptApi | string | (Optional) The api as represented the AWS JavaScript API. | | outputs | Output[] | (Required) specify the outputs to extract from the JavaScript JSON response. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `apiParams`Required ```typescript public readonly apiParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Required) API Params to submit with the request to the api. You may include variables which will be substitued for inputs during step execution as such {{ INPUT }} --- *Example* ```typescript { 'VolumeIds': ['{{ EbsDescribeInstance.VolumeId }}'] } ``` ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string (Required) The AWS api represented in PascalCase. This value is used as-is in the SSM yaml/json. This is used as the default for javaScriptApi (see that param). --- *Example* ```typescript DescribeInstances ``` ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService (Required) The AWS service to be invoked. --- *Example* ```typescript AwsService.S3 ``` ##### `javaScriptApi`Optional ```typescript public readonly javaScriptApi: string; ``` - *Type:* string - *Default:* will use the camelCaseApi param and substitute the first character for lowercase by default. (Optional) The api as represented the AWS JavaScript API. This is usually lowerCamelCase. This is used in the simulation run to execute the AWS API against the JavaScript SDK. --- *Example* ```typescript describeInstances ``` ##### `outputs`Required ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] (Required) specify the outputs to extract from the JavaScript JSON response. --- ### AwsInvocationProps #### Initializer ```typescript import { AwsInvocationProps } from '@cdklabs/cdk-ssm-documents' const awsInvocationProps: AwsInvocationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | apiParams | {[ key: string ]: any} | (Required) API Params to submit with the request to the api. | | pascalCaseApi | string | (Required) The AWS api represented in PascalCase. | | service | AwsService | (Required) The AWS service to be invoked. | | javaScriptApi | string | (Optional) The api as represented the AWS JavaScript API. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `apiParams`Required ```typescript public readonly apiParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Required) API Params to submit with the request to the api. You may include variables which will be substitued for inputs during step execution as such {{ INPUT }} --- *Example* ```typescript { 'VolumeIds': ['{{ EbsDescribeInstance.VolumeId }}'] } ``` ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string (Required) The AWS api represented in PascalCase. This value is used as-is in the SSM yaml/json. This is used as the default for javaScriptApi (see that param). --- *Example* ```typescript DescribeInstances ``` ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService (Required) The AWS service to be invoked. --- *Example* ```typescript AwsService.S3 ``` ##### `javaScriptApi`Optional ```typescript public readonly javaScriptApi: string; ``` - *Type:* string - *Default:* will use the camelCaseApi param and substitute the first character for lowercase by default. (Optional) The api as represented the AWS JavaScript API. This is usually lowerCamelCase. This is used in the simulation run to execute the AWS API against the JavaScript SDK. --- *Example* ```typescript describeInstances ``` ### AwsInvocationSimulationProps #### Initializer ```typescript import { AwsInvocationSimulationProps } from '@cdklabs/cdk-ssm-documents' const awsInvocationSimulationProps: AwsInvocationSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ### BodyOrUrlProp Allow passing in a body or URL version of the property value. #### Initializer ```typescript import { BodyOrUrlProp } from '@cdklabs/cdk-ssm-documents' const bodyOrUrlProp: BodyOrUrlProp = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | propType | BodyOrUrlType | Whether the body or URL was provided. | | value | IStringVariable | Body or URL string. | --- ##### `propType`Required ```typescript public readonly propType: BodyOrUrlType; ``` - *Type:* BodyOrUrlType Whether the body or URL was provided. --- ##### `value`Required ```typescript public readonly value: IStringVariable; ``` - *Type:* IStringVariable Body or URL string. --- ### BooleanInputProps #### Initializer ```typescript import { BooleanInputProps } from '@cdklabs/cdk-ssm-documents' const booleanInputProps: BooleanInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultValue | boolean | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: boolean; ``` - *Type:* boolean - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ### BranchStepProps #### Initializer ```typescript import { BranchStepProps } from '@cdklabs/cdk-ssm-documents' const branchStepProps: BranchStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | choices | Choice[] | (Required) list of choices. | | defaultStepName | string | (Optional) default step in all of the choices evaluate to false. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `choices`Required ```typescript public readonly choices: Choice[]; ``` - *Type:* Choice[] (Required) list of choices. The first matched choice will be used to jump to the step specified in the choice. --- ##### `defaultStepName`Optional ```typescript public readonly defaultStepName: string; ``` - *Type:* string - *Default:* undefined - the next step in the chain will be invoked. See AWS Documentation for branch below. (Optional) default step in all of the choices evaluate to false. --- ### ChangeInstanceStateSimulationProps Properties for ChangeInstanceStateStep. #### Initializer ```typescript import { ChangeInstanceStateSimulationProps } from '@cdklabs/cdk-ssm-documents' const changeInstanceStateSimulationProps: ChangeInstanceStateSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ### ChangeInstanceStateStepProps Properties for ChangeInstanceStateStep. #### Initializer ```typescript import { ChangeInstanceStateStepProps } from '@cdklabs/cdk-ssm-documents' const changeInstanceStateStepProps: ChangeInstanceStateStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | desiredState | IDesiredStateVariable | The desired state. | | instanceIds | IStringListVariable | The IDs of the instances. | | additionalInfo | IStringVariable | (Optional) Reserved. | | checkStateOnly | IBooleanVariable | (Optional) If false, sets the instance state to the desired state. | | force | IBooleanVariable | (Optional) If set, forces the instances to stop. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `desiredState`Required ```typescript public readonly desiredState: IDesiredStateVariable; ``` - *Type:* IDesiredStateVariable The desired state. When set to running, this action waits for the Amazon EC2 state to be Running, the Instance Status to be OK, and the System Status to be OK before completing. --- ##### `instanceIds`Required ```typescript public readonly instanceIds: IStringListVariable; ``` - *Type:* IStringListVariable The IDs of the instances. --- ##### `additionalInfo`Optional ```typescript public readonly additionalInfo: IStringVariable; ``` - *Type:* IStringVariable (Optional) Reserved. --- ##### `checkStateOnly`Optional ```typescript public readonly checkStateOnly: IBooleanVariable; ``` - *Type:* IBooleanVariable - *Default:* false (Optional) If false, sets the instance state to the desired state. If true, asserts the desired state using polling. --- ##### `force`Optional ```typescript public readonly force: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) If set, forces the instances to stop. The instances don't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option isn't recommended for EC2 instances for Windows Server. --- ### ChoiceProps Properties for a Choice used by the BranchStep. #### Initializer ```typescript import { ChoiceProps } from '@cdklabs/cdk-ssm-documents' const choiceProps: ChoiceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | constant | any | (Required) the constant to test against the inputToTest. | | jumpToStepName | string | A step to jump to if this choice is evaluated to true. | | operation | Operation | (Required) The operation used to compare the inputToTest with the constant. | | variable | IStringVariable \| INumberVariable \| IBooleanVariable | (Required) the input used to test using the operation with the constant. | --- ##### `constant`Required ```typescript public readonly constant: any; ``` - *Type:* any (Required) the constant to test against the inputToTest. --- ##### `jumpToStepName`Required ```typescript public readonly jumpToStepName: string; ``` - *Type:* string A step to jump to if this choice is evaluated to true. Must reference another step in the currently executing AutomationDocument. --- ##### `operation`Required ```typescript public readonly operation: Operation; ``` - *Type:* Operation (Required) The operation used to compare the inputToTest with the constant. --- ##### `variable`Required ```typescript public readonly variable: IStringVariable | INumberVariable | IBooleanVariable; ``` - *Type:* IStringVariable | INumberVariable | IBooleanVariable (Required) the input used to test using the operation with the constant. --- ### CommandDocumentProps #### Initializer ```typescript import { CommandDocumentProps } from '@cdklabs/cdk-ssm-documents' const commandDocumentProps: CommandDocumentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assumeRole | IStringVariable | (Optional) Assume role to use for this document. | | description | string | (Optional) Description of the document. | | docInputs | Input[] | (Optional) Inputs required by the document. | | docOutputs | DocumentOutput[] | (Optional) Outputs to be emitted from the document. | | documentFormat | DocumentFormat | (Optional) Specifies whether this document should be written as YAML or JSON. | | documentName | string | (Optional) Name of the document. | | header | string | (Optional) A Header/comment to include at the start of a YAML document. | | requires | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty \| aws-cdk-lib.IResolvable[] | `AWS::SSM::Document.Requires`. | | tags | aws-cdk-lib.CfnTag[] | `AWS::SSM::Document.Tags`. | | targetType | string | `AWS::SSM::Document.TargetType`. | | updateMethod | string | If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. | | versionName | string | `AWS::SSM::Document.VersionName`. | --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable (Optional) Assume role to use for this document. If provided, this value MUST be included as one of the documentInput names. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string (Optional) Description of the document. Defaults to the document name. --- ##### `docInputs`Optional ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] (Optional) Inputs required by the document. --- ##### `docOutputs`Optional ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] - *Default:* [] (Optional) Outputs to be emitted from the document. The outputs are placed in a StringSet called outputs (as is done in SSM). --- ##### `documentFormat`Optional ```typescript public readonly documentFormat: DocumentFormat; ``` - *Type:* DocumentFormat - *Default:* JSON (Optional) Specifies whether this document should be written as YAML or JSON. --- ##### `documentName`Optional ```typescript public readonly documentName: string; ``` - *Type:* string (Optional) Name of the document. Will default to the id provided for the CDK node. --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string (Optional) A Header/comment to include at the start of a YAML document. JSON documents do not support headers. --- ##### `requires`Optional ```typescript public readonly requires: IResolvable | DocumentRequiresProperty | IResolvable[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty | aws-cdk-lib.IResolvable[] `AWS::SSM::Document.Requires`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires) --- ##### `tags`Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] `AWS::SSM::Document.Tags`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags) --- ##### `targetType`Optional ```typescript public readonly targetType: string; ``` - *Type:* string `AWS::SSM::Document.TargetType`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype) --- ##### `updateMethod`Optional ```typescript public readonly updateMethod: string; ``` - *Type:* string If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod) --- ##### `versionName`Optional ```typescript public readonly versionName: string; ``` - *Type:* string `AWS::SSM::Document.VersionName`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname) --- ### CommandSimulationProps #### Initializer ```typescript import { CommandSimulationProps } from '@cdklabs/cdk-ssm-documents' const commandSimulationProps: CommandSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | simulationPlatform | Platform | The Platform used in executing the command step. | | environment | IEnvironment | (Optional) Specify here the environment in which to execute the scripts. | --- ##### `simulationPlatform`Required ```typescript public readonly simulationPlatform: Platform; ``` - *Type:* Platform The Platform used in executing the command step. --- ##### `environment`Optional ```typescript public readonly environment: IEnvironment; ``` - *Type:* IEnvironment - *Default:* LoggingEnvironment (Optional) Specify here the environment in which to execute the scripts. Use the DockerEnvironment to execute the commands inside the docker. You can alternatively use the LoggingEnvironment which simply logs the commands or MockEnvironment which saves them for validation. --- ### CommandStepProps #### Initializer ```typescript import { CommandStepProps } from '@cdklabs/cdk-ssm-documents' const commandStepProps: CommandStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ### ConfigureDockerStepProps Properties for ConfigureDocker step. #### Initializer ```typescript import { ConfigureDockerStepProps } from '@cdklabs/cdk-ssm-documents' const configureDockerStepProps: ConfigureDockerStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | action | IActionVariable | The type of action to perform. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `action`Required ```typescript public readonly action: IActionVariable; ``` - *Type:* IActionVariable The type of action to perform. True correlates to "Install" false correlates to "Uninstall" --- ### ConfigurePackageStepProps Properties ConfigurePackage step. #### Initializer ```typescript import { ConfigurePackageStepProps } from '@cdklabs/cdk-ssm-documents' const configurePackageStepProps: ConfigurePackageStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | packageAction | IActionVariable | Install or uninstall a package. | | packageName | IPackageNameVariable | The name of the AWS package to install or uninstall. | | additionalArguments | IStringMapVariable | The additional parameters to provide to your install, uninstall, or update scripts. | | installationType | IInstallationTypeVariable | The type of installation to perform. | | version | IStringVariable | A specific version of the package to install or uninstall. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `packageAction`Required ```typescript public readonly packageAction: IActionVariable; ``` - *Type:* IActionVariable Install or uninstall a package. --- ##### `packageName`Required ```typescript public readonly packageName: IPackageNameVariable; ``` - *Type:* IPackageNameVariable The name of the AWS package to install or uninstall. --- ##### `additionalArguments`Optional ```typescript public readonly additionalArguments: IStringMapVariable; ``` - *Type:* IStringMapVariable The additional parameters to provide to your install, uninstall, or update scripts. Each parameter must be prefixed with SSM_. You can reference a Parameter Store parameter in your additional arguments by using the convention {{ ssm:parameter-name }}. To use the additional parameter in your install, uninstall, or update script, you must reference the parameter as an environment variable using the syntax appropriate for the operating system. For example, in PowerShell, you reference the SSM_arg argument as $Env:SSM_arg. There is no limit to the number of arguments you define, but the additional argument input has a 4096 character limit. This limit includes all of the keys and values you define. --- ##### `installationType`Optional ```typescript public readonly installationType: IInstallationTypeVariable; ``` - *Type:* IInstallationTypeVariable The type of installation to perform. If you specify Uninstall and reinstall, the package is completely uninstalled, and then reinstalled. The application is unavailable until the reinstallation is complete. If you specify In-place update, only new or changed files are added to the existing installation according you instructions you provide in an update script. The application remains available throughout the update process. The In-place update option isn't supported for AWS-published packages. Uninstall and reinstall is the default value. --- ##### `version`Optional ```typescript public readonly version: IStringVariable; ``` - *Type:* IStringVariable A specific version of the package to install or uninstall. If installing, the system installs the latest published version, by default. If uninstalling, the system uninstalls the currently installed version, by default. If no installed version is found, the latest published version is downloaded, and the uninstall action is run. --- ### CopyImageStepProps Properties for CopyImageStep. #### Initializer ```typescript import { CopyImageStepProps } from '@cdklabs/cdk-ssm-documents' const copyImageStepProps: CopyImageStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | imageName | IStringVariable | The name for the image. | | sourceImageId | IStringVariable | The AMI ID to copy from the source Region. | | sourceRegion | IStringVariable | The region where the source AMI exists. | | clientToken | IStringVariable | (Optional) A unique, case-sensitive identifier that you provide to ensure request idempotency. | | encrypted | IBooleanVariable | (Optional) Encrypt the target AMI. | | imageDescription | IStringVariable | (Optional) A description of the image. | | kmsKeyId | IStringVariable | (Optional) The full Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting the snapshots of an image during a copy operation. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `imageName`Required ```typescript public readonly imageName: IStringVariable; ``` - *Type:* IStringVariable The name for the image. --- ##### `sourceImageId`Required ```typescript public readonly sourceImageId: IStringVariable; ``` - *Type:* IStringVariable The AMI ID to copy from the source Region. --- ##### `sourceRegion`Required ```typescript public readonly sourceRegion: IStringVariable; ``` - *Type:* IStringVariable The region where the source AMI exists. --- ##### `clientToken`Optional ```typescript public readonly clientToken: IStringVariable; ``` - *Type:* IStringVariable (Optional) A unique, case-sensitive identifier that you provide to ensure request idempotency. --- ##### `encrypted`Optional ```typescript public readonly encrypted: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) Encrypt the target AMI. --- ##### `imageDescription`Optional ```typescript public readonly imageDescription: IStringVariable; ``` - *Type:* IStringVariable (Optional) A description of the image. --- ##### `kmsKeyId`Optional ```typescript public readonly kmsKeyId: IStringVariable; ``` - *Type:* IStringVariable (Optional) The full Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting the snapshots of an image during a copy operation. --- ### CreateImageStepProps Properties for CreateImageStep. #### Initializer ```typescript import { CreateImageStepProps } from '@cdklabs/cdk-ssm-documents' const createImageStepProps: CreateImageStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | imageName | IStringVariable | The name for the image. | | instanceId | IStringVariable | The ID of the instance. | | blockDeviceMappings | IStringMapVariable | (Optional) The block devices for the instance. | | imageDescription | IStringVariable | (Optional) A description of the image. | | noReboot | IBooleanVariable | (Optional) By default, Amazon Elastic Compute Cloud (Amazon EC2) attempts to shut down and reboot the instance before creating the image. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `imageName`Required ```typescript public readonly imageName: IStringVariable; ``` - *Type:* IStringVariable The name for the image. --- ##### `instanceId`Required ```typescript public readonly instanceId: IStringVariable; ``` - *Type:* IStringVariable The ID of the instance. --- ##### `blockDeviceMappings`Optional ```typescript public readonly blockDeviceMappings: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) The block devices for the instance. --- ##### `imageDescription`Optional ```typescript public readonly imageDescription: IStringVariable; ``` - *Type:* IStringVariable (Optional) A description of the image. --- ##### `noReboot`Optional ```typescript public readonly noReboot: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) By default, Amazon Elastic Compute Cloud (Amazon EC2) attempts to shut down and reboot the instance before creating the image. If the No Reboot option is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed. If you don't want the instance to run after you create an AMI from it, first use the aws:changeInstanceState – Change or assert instance state action to stop the instance, and then use this aws:createImage action with the NoReboot option set to true. --- ### CreateStackSimulationProps Properties for CreateStackStep. #### Initializer ```typescript import { CreateStackSimulationProps } from '@cdklabs/cdk-ssm-documents' const createStackSimulationProps: CreateStackSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | | parameterResolver | IParameterResolver | (Optional) Resolver for secure strings in parameters. | | sleepHook | ISleepHook | (Optional) Whether to really perform a pause of the runtime. | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ##### `parameterResolver`Required ```typescript public readonly parameterResolver: IParameterResolver; ``` - *Type:* IParameterResolver - *Default:* Treats parameters as literal (Optional) Resolver for secure strings in parameters. Required to simulate if using tokens in parameters input. --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* SleeperImpl (Optional) Whether to really perform a pause of the runtime. To override sleep behavior, inject an ISleepHook impl or use the provided MockSleep class. --- ### CreateStackStepProps Properties for CreateStackStep. #### Initializer ```typescript import { CreateStackStepProps } from '@cdklabs/cdk-ssm-documents' const createStackStepProps: CreateStackStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | stackName | IStringVariable | The name that is associated with the stack. | | template | BodyOrUrlProp | Template body or URL. | | capabilities | IStringListVariable | (Optional) A list of values that you specify before CloudFormation can create certain stacks. | | clientRequestToken | IStringVariable | (Optional) A unique identifier for this CreateStack request. | | notificationARNs | IStringListVariable | (Optional) The Amazon Simple Notification Service (Amazon SNS) topic ARNs for publishing stack-related events. | | onStackFailure | IOnFailureVariable | (Optional) Determines the action to take if stack creation failed. | | parameters | IMapListVariable | (Optional) A list of Parameter structures that specify input parameters for the stack. | | resourceTypes | IStringListVariable | (Optional) The template resource types that you have permissions to work with for this create stack action. | | roleArn | IStringVariable | (Optional) The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. | | stackPolicy | BodyOrUrlProp | (Optional) Stack policy body or URL. | | tags | IMapListVariable | (Optional) Key-value pairs to associate with this stack. | | timeoutInMinutes | INumberVariable | (Optional) The amount of time that can pass before the stack status becomes CREATE_FAILED. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `stackName`Required ```typescript public readonly stackName: IStringVariable; ``` - *Type:* IStringVariable The name that is associated with the stack. The name must be unique in the Region in which you're creating the stack. --- ##### `template`Required ```typescript public readonly template: BodyOrUrlProp; ``` - *Type:* BodyOrUrlProp Template body or URL. For more information, see [Template Anatomy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html). --- ##### `capabilities`Optional ```typescript public readonly capabilities: IStringListVariable; ``` - *Type:* IStringListVariable (Optional) A list of values that you specify before CloudFormation can create certain stacks. Some stack templates include resources that can affect permissions in your AWS account. For example, creating new AWS Identity and Access Management (IAM) users can affect permissions in your account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Valid values include CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_AUTO_EXPAND. --- ##### `clientRequestToken`Optional ```typescript public readonly clientRequestToken: IStringVariable; ``` - *Type:* IStringVariable (Optional) A unique identifier for this CreateStack request. Specify this token if you set maxAttempts in this step to a value greater than 1. By specifying this token, CloudFormation knows that you aren't attempting to create a new stack with the same name. --- ##### `notificationARNs`Optional ```typescript public readonly notificationARNs: IStringListVariable; ``` - *Type:* IStringListVariable (Optional) The Amazon Simple Notification Service (Amazon SNS) topic ARNs for publishing stack-related events. --- ##### `onStackFailure`Optional ```typescript public readonly onStackFailure: IOnFailureVariable; ``` - *Type:* IOnFailureVariable - *Default:* Rollback on failure (Optional) Determines the action to take if stack creation failed. --- ##### `parameters`Optional ```typescript public readonly parameters: IMapListVariable; ``` - *Type:* IMapListVariable (Optional) A list of Parameter structures that specify input parameters for the stack. For more information, see the [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) data type. --- ##### `resourceTypes`Optional ```typescript public readonly resourceTypes: IStringListVariable; ``` - *Type:* IStringListVariable (Optional) The template resource types that you have permissions to work with for this create stack action. For example: AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. --- ##### `roleArn`Optional ```typescript public readonly roleArn: IStringVariable; ``` - *Type:* IStringVariable (Optional) The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants the least amount of privileges. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials. --- ##### `stackPolicy`Optional ```typescript public readonly stackPolicy: BodyOrUrlProp; ``` - *Type:* BodyOrUrlProp (Optional) Stack policy body or URL. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html). --- ##### `tags`Optional ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable (Optional) Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. You can specify a maximum number of 10 tags. --- ##### `timeoutInMinutes`Optional ```typescript public readonly timeoutInMinutes: INumberVariable; ``` - *Type:* INumberVariable (Optional) The amount of time that can pass before the stack status becomes CREATE_FAILED. If DisableRollback isn't set or is set to false, the stack will be rolled back. --- ### CreateTagsSimulationProps Properties for CreateTagStep. #### Initializer ```typescript import { CreateTagsSimulationProps } from '@cdklabs/cdk-ssm-documents' const createTagsSimulationProps: CreateTagsSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | | sleepHook | ISleepHook | (Optional) Whether to really perform a pause of the runtime. | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* SleeperImpl (Optional) Whether to really perform a pause of the runtime. To override sleep behavior, inject an ISleepHook impl or use the provided MockSleep class. --- ### CreateTagsStepProps Properties for CreateTagStep. #### Initializer ```typescript import { CreateTagsStepProps } from '@cdklabs/cdk-ssm-documents' const createTagsStepProps: CreateTagsStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | resourceIds | IStringListVariable | The IDs of the resource(s) to be tagged. | | tags | IMapListVariable | The tags to associate with the resource(s). | | resourceType | IResourceTypeVariable | (Optional) The type of resource(s) to be tagged. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `resourceIds`Required ```typescript public readonly resourceIds: IStringListVariable; ``` - *Type:* IStringListVariable The IDs of the resource(s) to be tagged. If resource type isn't “EC2”, this field can contain only a single item. --- ##### `tags`Required ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable The tags to associate with the resource(s). --- ##### `resourceType`Optional ```typescript public readonly resourceType: IResourceTypeVariable; ``` - *Type:* IResourceTypeVariable - *Default:* EC2 (Optional) The type of resource(s) to be tagged. Valid values: EC2 | ManagedInstance | MaintenanceWindow | Parameter --- ### DeleteImageSimulationProps Properties for DeleteImageStep. #### Initializer ```typescript import { DeleteImageSimulationProps } from '@cdklabs/cdk-ssm-documents' const deleteImageSimulationProps: DeleteImageSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | | sleepHook | ISleepHook | (Optional) Whether to really perform a pause of the runtime. | --- ##### `awsInvoker`Optional ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ##### `sleepHook`Optional ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* SleeperImpl (Optional) Whether to really perform a pause of the runtime. To override sleep behavior, inject an ISleepHook impl or use the provided MockSleep class. --- ### DeleteImageStepProps Properties for DeleteImageStep. #### Initializer ```typescript import { DeleteImageStepProps } from '@cdklabs/cdk-ssm-documents' const deleteImageStepProps: DeleteImageStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | imageId | IStringVariable | The ID of the image to be deleted. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `imageId`Required ```typescript public readonly imageId: IStringVariable; ``` - *Type:* IStringVariable The ID of the image to be deleted. --- ### DeleteStackStepProps Properties for DeleteStackStep. #### Initializer ```typescript import { DeleteStackStepProps } from '@cdklabs/cdk-ssm-documents' const deleteStackStepProps: DeleteStackStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | stackNameVariable | IStringVariable | (Optional) Variable that is fed into this step declaring which stack to delete. | | roleArn | IStringVariable | (Optional) The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `stackNameVariable`Required ```typescript public readonly stackNameVariable: IStringVariable; ``` - *Type:* IStringVariable - *Default:* StackName is the default value. (Optional) Variable that is fed into this step declaring which stack to delete. --- ##### `roleArn`Optional ```typescript public readonly roleArn: IStringVariable; ``` - *Type:* IStringVariable (Optional) The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants the least amount of privileges. If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials. --- ### DocumentOutput Outputs from a document via one of the steps. The outputs are available for use in other documents calling this document via aws:executeAutomation. The outputs returned from an automation document are returned as a String list named "ouptuts". #### Initializer ```typescript import { DocumentOutput } from '@cdklabs/cdk-ssm-documents' const documentOutput: DocumentOutput = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The step and name (in STEP.NAME format) to identify an output expected from one of the document steps. The name must therefore identify a step and an output or will fail validation. | | outputType | DataTypeEnum | The DataType expected by this output. | --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string The step and name (in STEP.NAME format) to identify an output expected from one of the document steps. The name must therefore identify a step and an output or will fail validation. --- *Example* ```typescript MyStep.MyOutput ``` ##### `outputType`Required ```typescript public readonly outputType: DataTypeEnum; ``` - *Type:* DataTypeEnum The DataType expected by this output. This will be validated in simulation mode and will also be used when printing to yaml/json. --- ### DocumentResult #### Initializer ```typescript import { DocumentResult } from '@cdklabs/cdk-ssm-documents' const documentResult: DocumentResult = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | executedSteps | string[] | All the steps that were executed in this Simulation. | | responseCode | ResponseCode | *No description.* | | outputs | {[ key: string ]: any} | May be empty if responseCode is FAILED/CANCELLED. | | stackTrace | string | undefined if responseCode is SUCCESS. | | documentOutputs | string[] | *No description.* | --- ##### `executedSteps`Required ```typescript public readonly executedSteps: string[]; ``` - *Type:* string[] All the steps that were executed in this Simulation. --- ##### `responseCode`Required ```typescript public readonly responseCode: ResponseCode; ``` - *Type:* ResponseCode --- ##### `outputs`Optional ```typescript public readonly outputs: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} May be empty if responseCode is FAILED/CANCELLED. There are no outputs provided for Command steps or documents. --- ##### `stackTrace`Optional ```typescript public readonly stackTrace: string; ``` - *Type:* string undefined if responseCode is SUCCESS. --- ##### `documentOutputs`Required ```typescript public readonly documentOutputs: string[]; ``` - *Type:* string[] --- ### DomainJoinStepProps Properties of DomainJoin step. #### Initializer ```typescript import { DomainJoinStepProps } from '@cdklabs/cdk-ssm-documents' const domainJoinStepProps: DomainJoinStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | directoryId | IStringVariable | The ID of the directory. | | directoryName | IStringVariable | The name of the domain. | | dnsIpAddresses | IStringListVariable | The IP addresses of the DNS servers. | | directoryOU | IStringVariable | (Optional) The organizational unit (OU). | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `directoryId`Required ```typescript public readonly directoryId: IStringVariable; ``` - *Type:* IStringVariable The ID of the directory. --- *Example* ```typescript "d-1234567890" ``` ##### `directoryName`Required ```typescript public readonly directoryName: IStringVariable; ``` - *Type:* IStringVariable The name of the domain. --- *Example* ```typescript "example.com" ``` ##### `dnsIpAddresses`Required ```typescript public readonly dnsIpAddresses: IStringListVariable; ``` - *Type:* IStringListVariable The IP addresses of the DNS servers. --- *Example* ```typescript ["198.51.100.1","198.51.100.2"] ``` ##### `directoryOU`Optional ```typescript public readonly directoryOU: IStringVariable; ``` - *Type:* IStringVariable (Optional) The organizational unit (OU). --- *Example* ```typescript "OU=test,DC=example,DC=com" ``` ### DownloadContentStepProps Properties.json for ps Module step. #### Initializer ```typescript import { DownloadContentStepProps } from '@cdklabs/cdk-ssm-documents' const downloadContentStepProps: DownloadContentStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | downloadableContent | IDownloadableContent | The information required to retrieve the content from the required source. | | destinationPath | IStringVariable | (Optional) An optional local path on the instance where you want to download the file. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `downloadableContent`Required ```typescript public readonly downloadableContent: IDownloadableContent; ``` - *Type:* IDownloadableContent The information required to retrieve the content from the required source. This is a dictionary whose format changes based on the sourceType See the aws documentation for more info https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-plugins.html#aws-downloadContent --- ##### `destinationPath`Optional ```typescript public readonly destinationPath: IStringVariable; ``` - *Type:* IStringVariable (Optional) An optional local path on the instance where you want to download the file. If you don't specify a path, the content is downloaded to a path relative to your command ID. --- ### EnvironmentProps #### Initializer ```typescript import { EnvironmentProps } from '@cdklabs/cdk-ssm-documents' const environmentProps: EnvironmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environment | IEnvironment | (Optional) Specify here the environment in which to execute the scripts. | --- ##### `environment`Required ```typescript public readonly environment: IEnvironment; ``` - *Type:* IEnvironment - *Default:* LoggingEnvironment (Optional) Specify here the environment in which to execute the scripts. Use the DockerEnvironment to execute the commands inside the docker. You can alternatively use the LoggingEnvironment which simply logs the commands or MockEnvironment which saves them for validation. --- ### ExecuteAutomationOutputs Outputs for aws:executeAutomation. #### Initializer ```typescript import { ExecuteAutomationOutputs } from '@cdklabs/cdk-ssm-documents' const executeAutomationOutputs: ExecuteAutomationOutputs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | executionId | string | The ID of the secondary automation. | | status | string | The status of the secondary automation. | | output | string[] | The output generated by the secondary automation. | --- ##### `executionId`Required ```typescript public readonly executionId: string; ``` - *Type:* string The ID of the secondary automation. --- ##### `status`Required ```typescript public readonly status: string; ``` - *Type:* string The status of the secondary automation. --- ##### `output`Optional ```typescript public readonly output: string[]; ``` - *Type:* string[] The output generated by the secondary automation. --- ### ExecuteAutomationProps Inputs for aws:executeAutomation. #### Initializer ```typescript import { ExecuteAutomationProps } from '@cdklabs/cdk-ssm-documents' const executeAutomationProps: ExecuteAutomationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentName | string | *No description.* | | documentVersion | string | *No description.* | | maxConcurrency | string | *No description.* | | maxErrors | string | *No description.* | | runtimeParameters | {[ key: string ]: any} | *No description.* | | tags | {[ key: string ]: any}[] | *No description.* | | targetLocations | {[ key: string ]: any}[] | *No description.* | | targetMaps | {[ key: string ]: any}[] | *No description.* | | targetParameterName | string | *No description.* | | targets | {[ key: string ]: any}[] | *No description.* | --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string --- ##### `documentVersion`Optional ```typescript public readonly documentVersion: string; ``` - *Type:* string --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: string; ``` - *Type:* string --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: string; ``` - *Type:* string --- ##### `runtimeParameters`Optional ```typescript public readonly runtimeParameters: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ##### `tags`Optional ```typescript public readonly tags: {[ key: string ]: any}[]; ``` - *Type:* {[ key: string ]: any}[] --- ##### `targetLocations`Optional ```typescript public readonly targetLocations: {[ key: string ]: any}[]; ``` - *Type:* {[ key: string ]: any}[] --- ##### `targetMaps`Optional ```typescript public readonly targetMaps: {[ key: string ]: any}[]; ``` - *Type:* {[ key: string ]: any}[] --- ##### `targetParameterName`Optional ```typescript public readonly targetParameterName: string; ``` - *Type:* string --- ##### `targets`Optional ```typescript public readonly targets: {[ key: string ]: any}[]; ``` - *Type:* {[ key: string ]: any}[] --- ### ExecuteAutomationStepProps #### Initializer ```typescript import { ExecuteAutomationStepProps } from '@cdklabs/cdk-ssm-documents' const executeAutomationStepProps: ExecuteAutomationStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | documentName | IStringVariable | *No description.* | | documentVersion | IStringVariable | *No description.* | | maxConcurrency | IStringVariable | *No description.* | | maxErrors | IStringVariable | *No description.* | | runtimeParameters | IStringMapVariable | *No description.* | | tags | IMapListVariable | *No description.* | | targetLocations | IMapListVariable | *No description.* | | targetMaps | IMapListVariable | *No description.* | | targetParameterName | IStringVariable | *No description.* | | targets | IMapListVariable | *No description.* | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `documentName`Required ```typescript public readonly documentName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `documentVersion`Optional ```typescript public readonly documentVersion: IStringVariable; ``` - *Type:* IStringVariable --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: IStringVariable; ``` - *Type:* IStringVariable --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: IStringVariable; ``` - *Type:* IStringVariable --- ##### `runtimeParameters`Optional ```typescript public readonly runtimeParameters: IStringMapVariable; ``` - *Type:* IStringMapVariable --- ##### `tags`Optional ```typescript public readonly tags: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetLocations`Optional ```typescript public readonly targetLocations: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetMaps`Optional ```typescript public readonly targetMaps: IMapListVariable; ``` - *Type:* IMapListVariable --- ##### `targetParameterName`Optional ```typescript public readonly targetParameterName: IStringVariable; ``` - *Type:* IStringVariable --- ##### `targets`Optional ```typescript public readonly targets: IMapListVariable; ``` - *Type:* IMapListVariable --- ### ExecuteScriptStepProps Properties for ExecuteScriptStep. #### Initializer ```typescript import { ExecuteScriptStepProps } from '@cdklabs/cdk-ssm-documents' const executeScriptStepProps: ExecuteScriptStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | code | ScriptCode | Inline code to be executed. | | inputPayload | {[ key: string ]: IGenericVariable} | InputPayload that will be passed to the first parameter of the handler. | | language | ScriptLanguage | (Required) Language used to execute the script. | | outputs | Output[] | (Optional) Outputs that the function is expected to return. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `code`Required ```typescript public readonly code: ScriptCode; ``` - *Type:* ScriptCode Inline code to be executed. String will be used to produce function in yaml/json. Simulation will execute the function in this code using the language specified. --- ##### `inputPayload`Required ```typescript public readonly inputPayload: {[ key: string ]: IGenericVariable}; ``` - *Type:* {[ key: string ]: IGenericVariable} InputPayload that will be passed to the first parameter of the handler. This can be used to pass input data to the script. The key of this dict is the variable name that will be available to the code. The value is the Variable object. --- ##### `language`Required ```typescript public readonly language: ScriptLanguage; ``` - *Type:* ScriptLanguage (Required) Language used to execute the script. --- ##### `outputs`Optional ```typescript public readonly outputs: Output[]; ``` - *Type:* Output[] - *Default:* [] (Optional) Outputs that the function is expected to return. Be sure to prefix the selector for these outputs with "$.Payload." for executeScript step outputs. --- ### ExecuteStateMachineStepProps Props for ExecuteStateMachine step. #### Initializer ```typescript import { ExecuteStateMachineStepProps } from '@cdklabs/cdk-ssm-documents' const executeStateMachineStepProps: ExecuteStateMachineStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | stateMachineArn | IStringVariable | The Amazon Resource Name (ARN) of the Step Functions state machine. | | executionName | IStringVariable | (Optional) The name of the execution. | | input | IStringVariable | (Optional) A string that contains the JSON input data for the execution. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `stateMachineArn`Required ```typescript public readonly stateMachineArn: IStringVariable; ``` - *Type:* IStringVariable The Amazon Resource Name (ARN) of the Step Functions state machine. --- ##### `executionName`Optional ```typescript public readonly executionName: IStringVariable; ``` - *Type:* IStringVariable (Optional) The name of the execution. --- ##### `input`Optional ```typescript public readonly input: IStringVariable; ``` - *Type:* IStringVariable (Optional) A string that contains the JSON input data for the execution. --- ### GitContentProps Properties for sourceType Git. #### Initializer ```typescript import { GitContentProps } from '@cdklabs/cdk-ssm-documents' const gitContentProps: GitContentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repository | IStringVariable | The Git repository URL to the file or directory you want to download. | | branch | string | The default is master. | | commitId | string | The default is head. | | password | SecureVariable | The password to use when connecting to the repository you specify using HTTP. | | privateSshKey | SecureVariable | The SSH key to use when connecting to the repository you specify. | | skipHostKeyChecking | IBooleanVariable | Determines the value of the StrictHostKeyChecking option when connecting to the repository you specify. | | userName | SecureVariable | The username to use when connecting to the repository you specify using HTTP. | --- ##### `repository`Required ```typescript public readonly repository: IStringVariable; ``` - *Type:* IStringVariable The Git repository URL to the file or directory you want to download. --- ##### `branch`Optional ```typescript public readonly branch: string; ``` - *Type:* string The default is master. branch parameter is required only if your SSM document is stored in a branch other than master. Supply either commitId or branch (or neither). --- *Example* ```typescript main ``` ##### `commitId`Optional ```typescript public readonly commitId: string; ``` - *Type:* string The default is head. To use the version of your SSM document in a commit other than the latest, specify the full commit ID. For example: "bbc1ddb94...b76d3bEXAMPLE". Supply either commitId or branch (or neither). --- ##### `password`Optional ```typescript public readonly password: SecureVariable; ``` - *Type:* SecureVariable The password to use when connecting to the repository you specify using HTTP. --- ##### `privateSshKey`Optional ```typescript public readonly privateSshKey: SecureVariable; ``` - *Type:* SecureVariable The SSH key to use when connecting to the repository you specify. --- ##### `skipHostKeyChecking`Optional ```typescript public readonly skipHostKeyChecking: IBooleanVariable; ``` - *Type:* IBooleanVariable Determines the value of the StrictHostKeyChecking option when connecting to the repository you specify. The default value is false. --- ##### `userName`Optional ```typescript public readonly userName: SecureVariable; ``` - *Type:* SecureVariable The username to use when connecting to the repository you specify using HTTP. --- ### GitHubContentProps Properties for sourceType GitHub. #### Initializer ```typescript import { GitHubContentProps } from '@cdklabs/cdk-ssm-documents' const gitHubContentProps: GitHubContentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | owner | IStringVariable | The repository owner. | | path | IStringVariable | The path to the file or directory you want to download. | | repository | IStringVariable | The name of the repository. | | tokenInfo | SecureVariable | The Systems Manager parameter (a SecureString parameter) where you store your GitHub access token information. | | branch | string | The default is master. | | commitId | string | The default is head. | --- ##### `owner`Required ```typescript public readonly owner: IStringVariable; ``` - *Type:* IStringVariable The repository owner. --- ##### `path`Required ```typescript public readonly path: IStringVariable; ``` - *Type:* IStringVariable The path to the file or directory you want to download. --- ##### `repository`Required ```typescript public readonly repository: IStringVariable; ``` - *Type:* IStringVariable The name of the repository. --- ##### `tokenInfo`Required ```typescript public readonly tokenInfo: SecureVariable; ``` - *Type:* SecureVariable The Systems Manager parameter (a SecureString parameter) where you store your GitHub access token information. --- ##### `branch`Optional ```typescript public readonly branch: string; ``` - *Type:* string The default is master. branch parameter is required only if your SSM document is stored in a branch other than master. Supply either commitId or branch (or neither). --- *Example* ```typescript main ``` ##### `commitId`Optional ```typescript public readonly commitId: string; ``` - *Type:* string The default is head. To use the version of your SSM document in a commit other than the latest, specify the full commit ID. For example: "bbc1ddb94...b76d3bEXAMPLE". Supply either commitId or branch (or neither). --- ### HttpContentProps Properties for sourceType HTTP. #### Initializer ```typescript import { HttpContentProps } from '@cdklabs/cdk-ssm-documents' const httpContentProps: HttpContentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | url | IStringVariable | The URL to the file or directory you want to download. | | allowInsecureDownload | IBooleanVariable | Determines whether a download can be performed over a connection that isn't encrypted with Secure Socket Layer (SSL) or Transport Layer Security (TLS). | | authMethod | AuthMethod | Determines whether a username and password are used for authentication when connecting to the url you specify. | --- ##### `url`Required ```typescript public readonly url: IStringVariable; ``` - *Type:* IStringVariable The URL to the file or directory you want to download. --- ##### `allowInsecureDownload`Optional ```typescript public readonly allowInsecureDownload: IBooleanVariable; ``` - *Type:* IBooleanVariable Determines whether a download can be performed over a connection that isn't encrypted with Secure Socket Layer (SSL) or Transport Layer Security (TLS). The default value is false. We don't recommend performing downloads without encryption. If you choose to do so, you assume all associated risks. Security is a shared responsibility between AWS and you. This is described as the shared responsibility model. To learn more, see the shared responsibility model. --- ##### `authMethod`Optional ```typescript public readonly authMethod: AuthMethod; ``` - *Type:* AuthMethod Determines whether a username and password are used for authentication when connecting to the url you specify. If you specify Basic or Digest, you must provide values for the username and password parameters. To use the Digest method, SSM Agent version 3.0.1181.0 or later must be installed on your instance. The Digest method supports MD5 and SHA256 encryption. --- ### IncidentResponseProps Provides props IncidentResponse. #### Initializer ```typescript import { IncidentResponseProps } from '@cdklabs/cdk-ssm-documents' const incidentResponseProps: IncidentResponseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actions | IncidentResponseAction[] | The actions that the response plan starts at the beginning of an incident. | | incidentTemplate | IncidentTemplate | Details used to create an incident when using this response plan. | | chatChannel | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ChatChannelProperty \| aws-cdk-lib.IResolvable | The AWS Chatbot chat channel used for collaboration during an incident. | | displayName | string | The human readable name of the response plan. | | engagements | string[] | The contacts and escalation plans that the response plan engages during an incident. | | tags | aws-cdk-lib.CfnTag[] | An array of key-value pairs to apply to this resource. | --- ##### `actions`Required ```typescript public readonly actions: IncidentResponseAction[]; ``` - *Type:* IncidentResponseAction[] The actions that the response plan starts at the beginning of an incident. --- ##### `incidentTemplate`Required ```typescript public readonly incidentTemplate: IncidentTemplate; ``` - *Type:* IncidentTemplate Details used to create an incident when using this response plan. --- ##### `chatChannel`Optional ```typescript public readonly chatChannel: ChatChannelProperty | IResolvable; ``` - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ChatChannelProperty | aws-cdk-lib.IResolvable The AWS Chatbot chat channel used for collaboration during an incident. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-chatchannel](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-chatchannel) --- ##### `displayName`Optional ```typescript public readonly displayName: string; ``` - *Type:* string The human readable name of the response plan. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-displayname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-displayname) --- ##### `engagements`Optional ```typescript public readonly engagements: string[]; ``` - *Type:* string[] The contacts and escalation plans that the response plan engages during an incident. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-engagements](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-engagements) --- ##### `tags`Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-tags) --- ### IncidentTemplateProps Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html. #### Initializer ```typescript import { IncidentTemplateProps } from '@cdklabs/cdk-ssm-documents' const incidentTemplateProps: IncidentTemplateProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dedupeString | string | Used to create only one incident record for an incident. | | incidentTags | aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.CfnTag[] | `CfnResponsePlan.IncidentTemplateProperty.IncidentTags`. | | notificationTargets | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.NotificationTargetItemProperty \| aws-cdk-lib.IResolvable[] | The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. | | summary | string | The summary describes what has happened during the incident. | --- ##### `dedupeString`Optional ```typescript public readonly dedupeString: string; ``` - *Type:* string Used to create only one incident record for an incident. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-dedupestring](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-dedupestring) --- ##### `incidentTags`Optional ```typescript public readonly incidentTags: IResolvable | IResolvable | CfnTag[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.CfnTag[] `CfnResponsePlan.IncidentTemplateProperty.IncidentTags`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-incidenttags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-incidenttags) --- ##### `notificationTargets`Optional ```typescript public readonly notificationTargets: IResolvable | NotificationTargetItemProperty | IResolvable[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.NotificationTargetItemProperty | aws-cdk-lib.IResolvable[] The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel using the SNS topics. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-notificationtargets](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-notificationtargets) --- ##### `summary`Optional ```typescript public readonly summary: string; ``` - *Type:* string The summary describes what has happened during the incident. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-summary](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-summary) --- ### InputProps Properties of inputs supported by SSM documents. These are NOT used for declaring step inputs, rather only for document inputs. See https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-doc-syntax.html #### Initializer ```typescript import { InputProps } from '@cdklabs/cdk-ssm-documents' const inputProps: InputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | inputType | DataTypeEnum | (Required) The DataTypeEnum of the input. | | name | string | (Required) The name of the input by which to be referenced by steps in the document. | | allowedPattern | string | (Optional) Pattern that this input value must match. | | allowedValues | any[] | (Optional) List of allowed values that this input may be. | | defaultValue | any | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | | maxChars | number | (Optional) Maximum number of chars that this input value (string) must contain. | | maxItems | number | (Optional) Maximum number of items that this input value (list) must contain. | | minChars | number | (Optional) Minimum number of chars that this input value (string) must contain. | | minItems | number | (Optional) Minimum number of items that this input value (list) must contain. | --- ##### `inputType`Required ```typescript public readonly inputType: DataTypeEnum; ``` - *Type:* DataTypeEnum (Required) The DataTypeEnum of the input. --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string (Required) The name of the input by which to be referenced by steps in the document. --- ##### `allowedPattern`Optional ```typescript public readonly allowedPattern: string; ``` - *Type:* string - *Default:* undefined (Optional) Pattern that this input value must match. --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: any[]; ``` - *Type:* any[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: any; ``` - *Type:* any - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ##### `maxChars`Optional ```typescript public readonly maxChars: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of chars that this input value (string) must contain. --- ##### `maxItems`Optional ```typescript public readonly maxItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of items that this input value (list) must contain. --- ##### `minChars`Optional ```typescript public readonly minChars: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of chars that this input value (string) must contain. --- ##### `minItems`Optional ```typescript public readonly minItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of items that this input value (list) must contain. --- ### IntegerInputProps #### Initializer ```typescript import { IntegerInputProps } from '@cdklabs/cdk-ssm-documents' const integerInputProps: IntegerInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedValues | number[] | (Optional) List of allowed values that this input may be. | | defaultValue | number | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: number[]; ``` - *Type:* number[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: number; ``` - *Type:* number - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ### Invocation #### Initializer ```typescript import { Invocation } from '@cdklabs/cdk-ssm-documents' const invocation: Invocation = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsApi | string | (Required) AWS api to invoke; | | awsParams | {[ key: string ]: any} | (Required )AWS params. | | service | AwsService | (Required) AWS service to invoke. | --- ##### `awsApi`Required ```typescript public readonly awsApi: string; ``` - *Type:* string (Required) AWS api to invoke; should be referenced using lowerCamelCase. --- *Example* ```typescript describeInstance ``` ##### `awsParams`Required ```typescript public readonly awsParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Required )AWS params. --- *Example* ```typescript { 'Filters': [{'Name': 'instance-id', 'Values': ['{{ InstanceId }}'] }] } ``` ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService (Required) AWS service to invoke. --- *Example* ```typescript AwsService.EC2 ``` ### InvokeLambdaFunctionStepProps Properties for InvokeLambdaFunctionStep. #### Initializer ```typescript import { InvokeLambdaFunctionStepProps } from '@cdklabs/cdk-ssm-documents' const invokeLambdaFunctionStepProps: InvokeLambdaFunctionStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | functionName | IStringVariable | The name of the Lambda function. | | clientContext | IStringVariable | (Optional) The client-specific information. | | invocationType | IStringVariable | (Optional) The invocation type. | | logType | IStringVariable | (Optional) If the default value is Tail, the invocation type must be RequestResponse. | | payload | IStringMapVariable | (Optional) The JSON input for your Lambda function. | | qualifier | IStringVariable | (Optional) The function version or alias name. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `functionName`Required ```typescript public readonly functionName: IStringVariable; ``` - *Type:* IStringVariable The name of the Lambda function. This function must exist. --- ##### `clientContext`Optional ```typescript public readonly clientContext: IStringVariable; ``` - *Type:* IStringVariable (Optional) The client-specific information. --- ##### `invocationType`Optional ```typescript public readonly invocationType: IStringVariable; ``` - *Type:* IStringVariable (Optional) The invocation type. The default value is RequestResponse. --- ##### `logType`Optional ```typescript public readonly logType: IStringVariable; ``` - *Type:* IStringVariable (Optional) If the default value is Tail, the invocation type must be RequestResponse. Lambda returns the last 4 KB of log data produced by your Lambda function, base64-encoded. --- ##### `payload`Optional ```typescript public readonly payload: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) The JSON input for your Lambda function. --- ##### `qualifier`Optional ```typescript public readonly qualifier: IStringVariable; ``` - *Type:* IStringVariable (Optional) The function version or alias name. --- ### InvokeWebhookProps The properties for IWebhook.Invoke. #### Initializer ```typescript import { InvokeWebhookProps } from '@cdklabs/cdk-ssm-documents' const invokeWebhookProps: InvokeWebhookProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | integrationName | string | The name of the Automation integration. | | body | string | (Optional) The payload you want to send when your webhook integration is invoked. | --- ##### `integrationName`Required ```typescript public readonly integrationName: string; ``` - *Type:* string The name of the Automation integration. For example, exampleIntegration. The integration you specify must already exist. --- ##### `body`Optional ```typescript public readonly body: string; ``` - *Type:* string (Optional) The payload you want to send when your webhook integration is invoked. --- ### InvokeWebhookResult Response from IWebhook.Invoke. #### Initializer ```typescript import { InvokeWebhookResult } from '@cdklabs/cdk-ssm-documents' const invokeWebhookResult: InvokeWebhookResult = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | response | string | The text received from the webhook provider response. | | responseCode | number | The HTTP status code received from the webhook provider response. | --- ##### `response`Required ```typescript public readonly response: string; ``` - *Type:* string The text received from the webhook provider response. --- ##### `responseCode`Required ```typescript public readonly responseCode: number; ``` - *Type:* number The HTTP status code received from the webhook provider response. --- ### InvokeWebhookSimulationProps Properties for InvokeWebhookStep. #### Initializer ```typescript import { InvokeWebhookSimulationProps } from '@cdklabs/cdk-ssm-documents' const invokeWebhookSimulationProps: InvokeWebhookSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | webhook | IWebhook | (Optional) Hook for simulating aws:invokeWebhook. | --- ##### `webhook`Required ```typescript public readonly webhook: IWebhook; ``` - *Type:* IWebhook - *Default:* Returns 204 with an empty response (Optional) Hook for simulating aws:invokeWebhook. --- ### InvokeWebhookStepProps Properties for InvokeWebhookStep. #### Initializer ```typescript import { InvokeWebhookStepProps } from '@cdklabs/cdk-ssm-documents' const invokeWebhookStepProps: InvokeWebhookStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | integrationName | IStringVariable | The name of the Automation integration. | | body | IStringVariable | (Optional) The payload you want to send when your webhook integration is invoked. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `integrationName`Required ```typescript public readonly integrationName: IStringVariable; ``` - *Type:* IStringVariable The name of the Automation integration. For example, exampleIntegration. The integration you specify must already exist. --- ##### `body`Optional ```typescript public readonly body: IStringVariable; ``` - *Type:* IStringVariable (Optional) The payload you want to send when your webhook integration is invoked. --- ### MapListInputProps #### Initializer ```typescript import { MapListInputProps } from '@cdklabs/cdk-ssm-documents' const mapListInputProps: MapListInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedValues | any[] | (Optional) List of allowed values that this input may be. | | defaultValue | any | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | | maxItems | number | (Optional) Maximum number of items that this input value (list) must contain. | | minItems | number | (Optional) Minimum number of items that this input value (list) must contain. | --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: any[]; ``` - *Type:* any[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: any; ``` - *Type:* any - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ##### `maxItems`Optional ```typescript public readonly maxItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of items that this input value (list) must contain. --- ##### `minItems`Optional ```typescript public readonly minItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of items that this input value (list) must contain. --- ### Output Object used to specify step output. #### Initializer ```typescript import { Output } from '@cdklabs/cdk-ssm-documents' const output: Output = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name that can be used by subsequent steps to refernce the stored value. | | outputType | DataTypeEnum | The DataType expected by this output. | | selector | string | Json selector for locating the value in the json step response. | --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string The name that can be used by subsequent steps to refernce the stored value. Note that Outputs will be PREPENDED with the step name. --- ##### `outputType`Required ```typescript public readonly outputType: DataTypeEnum; ``` - *Type:* DataTypeEnum The DataType expected by this output. This will be validated in simulation mode and will also be used when printing to yaml/json. --- ##### `selector`Required ```typescript public readonly selector: string; ``` - *Type:* string Json selector for locating the value in the json step response. --- ### PauseSimulationProps Properties for PauseStep. #### Initializer ```typescript import { PauseSimulationProps } from '@cdklabs/cdk-ssm-documents' const pauseSimulationProps: PauseSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pauseHook | IPauseHook | (Optional) Pause hook to be called to pause the execution. | --- ##### `pauseHook`Required ```typescript public readonly pauseHook: IPauseHook; ``` - *Type:* IPauseHook - *Default:* PauseHook instance. PauseHook may not work in exported JSII languages. Override interface as needed. (Optional) Pause hook to be called to pause the execution. To mock this implementation either inject an instance of IPauseHook or use the provided MockPause class. --- ### PreconditionProps The precondition parameter is used as a comparator of SSM documents inputs to determine whether a command step would be executed or not. See https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html #### Initializer ```typescript import { PreconditionProps } from '@cdklabs/cdk-ssm-documents' const preconditionProps: PreconditionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operationType | Operation | (Required) the operation used to compare the parameter with the variable. | | variable1 | IGenericVariable | (Required) the variable to compare against the constant. | | variable2 | IGenericVariable | (Required) the being compared against the variable. | --- ##### `operationType`Required ```typescript public readonly operationType: Operation; ``` - *Type:* Operation (Required) the operation used to compare the parameter with the variable. --- ##### `variable1`Required ```typescript public readonly variable1: IGenericVariable; ``` - *Type:* IGenericVariable (Required) the variable to compare against the constant. --- ##### `variable2`Required ```typescript public readonly variable2: IGenericVariable; ``` - *Type:* IGenericVariable (Required) the being compared against the variable. --- ### PsModuleStepProps Properties for ps Module step. #### Initializer ```typescript import { PsModuleStepProps } from '@cdklabs/cdk-ssm-documents' const psModuleStepProps: PsModuleStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | source | IStringVariable | The URL or local path on the instance to the application .zip file. The name of the zip file must be the name of the module to be installed. | | runCommand | IStringVariable[] | Specify the commands to run or the path to an existing script on the instance. | | sourceHash | IStringVariable | (Optional) The SHA256 hash of the .zip file. | | timeoutSeconds | number | (Optional) The time in seconds for a command to be completed before it's considered to have failed. | | workingDirectory | IStringVariable | (Optional) The path to the working directory on your instance. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `source`Required ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable The URL or local path on the instance to the application .zip file. The name of the zip file must be the name of the module to be installed. --- ##### `runCommand`Optional ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] Specify the commands to run or the path to an existing script on the instance. --- ##### `sourceHash`Optional ```typescript public readonly sourceHash: IStringVariable; ``` - *Type:* IStringVariable (Optional) The SHA256 hash of the .zip file. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number (Optional) The time in seconds for a command to be completed before it's considered to have failed. When the timeout is reached, Systems Manager stops the command execution. --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable (Optional) The path to the working directory on your instance. --- ### RequiredAutomationSimulationProps The same interface as AutomationSimulationProps but all fields are required. #### Initializer ```typescript import { RequiredAutomationSimulationProps } from '@cdklabs/cdk-ssm-documents' const requiredAutomationSimulationProps: RequiredAutomationSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approveHook | IApproveHook | *No description.* | | awsInvoker | IAwsInvoker | *No description.* | | executeAutomationHook | IExecuteAutomationHook | *No description.* | | inputObserver | IObserver | *No description.* | | outputObserver | IObserver | *No description.* | | parameterResolver | IParameterResolver | *No description.* | | pauseHook | IPauseHook | *No description.* | | runCommandHook | IRunCommandHook | *No description.* | | sleepHook | ISleepHook | *No description.* | | webhook | IWebhook | *No description.* | --- ##### `approveHook`Required ```typescript public readonly approveHook: IApproveHook; ``` - *Type:* IApproveHook --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `executeAutomationHook`Required ```typescript public readonly executeAutomationHook: IExecuteAutomationHook; ``` - *Type:* IExecuteAutomationHook --- ##### `inputObserver`Required ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `outputObserver`Required ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `parameterResolver`Required ```typescript public readonly parameterResolver: IParameterResolver; ``` - *Type:* IParameterResolver --- ##### `pauseHook`Required ```typescript public readonly pauseHook: IPauseHook; ``` - *Type:* IPauseHook --- ##### `runCommandHook`Required ```typescript public readonly runCommandHook: IRunCommandHook; ``` - *Type:* IRunCommandHook --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook --- ##### `webhook`Required ```typescript public readonly webhook: IWebhook; ``` - *Type:* IWebhook --- ### RequiredCommandSimulationProps The same interface as CommandSimulationProps but all fields are required. #### Initializer ```typescript import { RequiredCommandSimulationProps } from '@cdklabs/cdk-ssm-documents' const requiredCommandSimulationProps: RequiredCommandSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environment | IEnvironment | *No description.* | | simulationPlatform | Platform | *No description.* | --- ##### `environment`Required ```typescript public readonly environment: IEnvironment; ``` - *Type:* IEnvironment --- ##### `simulationPlatform`Required ```typescript public readonly simulationPlatform: Platform; ``` - *Type:* Platform --- ### RunCommandOutputs Outputs for aws:runCommand. #### Initializer ```typescript import { RunCommandOutputs } from '@cdklabs/cdk-ssm-documents' const runCommandOutputs: RunCommandOutputs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commandId | string | The ID of the command. | | status | string | The status of the command. | | output | string | The output of the command. | | responseCode | number | The response code of the command. | --- ##### `commandId`Required ```typescript public readonly commandId: string; ``` - *Type:* string The ID of the command. --- ##### `status`Required ```typescript public readonly status: string; ``` - *Type:* string The status of the command. --- ##### `output`Optional ```typescript public readonly output: string; ``` - *Type:* string The output of the command. --- ##### `responseCode`Optional ```typescript public readonly responseCode: number; ``` - *Type:* number The response code of the command. --- ### RunCommandProps Inputs for aws:runCommand. #### Initializer ```typescript import { RunCommandProps } from '@cdklabs/cdk-ssm-documents' const runCommandProps: RunCommandProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentName | string | If the Command type document is owned by you or AWS, specify the name of the document. | | targets | string[] | The instance IDs where you want the command to run. You can specify a maximum of 50 IDs. | | cloudWatchOutputConfig | {[ key: string ]: any} | (Optional) Configuration options for sending command output to Amazon CloudWatch Logs. | | comment | string | (Optional) User-defined information about the command. | | documentHash | string | (Optional) The hash for the document. | | documentHashType | string | (Optional) The type of the hash. | | maxConcurrency | number | (Optional) The maximum concurrency. | | maxErrors | number | (Optional) The maximum errors. | | notificationConfig | {[ key: string ]: any} | (Optional) The configurations for sending notifications. | | outputS3BucketName | string | (Optional) The name of the S3 bucket for command output responses. | | outputS3KeyPrefix | string | (Optional) The prefix. | | parameters | {[ key: string ]: any} | (Optional) The required and optional parameters specified in the document. | | serviceRoleArn | string | (Optional) The ARN of the AWS Identity and Access Management (IAM) role. | | timeoutSeconds | number | (Optional) The amount of time in seconds to wait for a command to deliver to the AWS Systems Manager SSM Agent on an instance. | --- ##### `documentName`Required ```typescript public readonly documentName: string; ``` - *Type:* string If the Command type document is owned by you or AWS, specify the name of the document. If you're using a document shared with you by a different AWS account, specify the Amazon Resource Name (ARN) of the document. --- ##### `targets`Required ```typescript public readonly targets: string[]; ``` - *Type:* string[] The instance IDs where you want the command to run. You can specify a maximum of 50 IDs. You can also use the pseudo parameter {{ RESOURCE_ID }} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html). Another alternative is to send commands to a fleet of instances by using the Targets parameter. The Targets parameter accepts Amazon Elastic Compute Cloud (Amazon EC2) tags. For more information about how to use the Targets parameter, see [Using targets and rate controls to send commands to a fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html). --- ##### `cloudWatchOutputConfig`Optional ```typescript public readonly cloudWatchOutputConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Optional) Configuration options for sending command output to Amazon CloudWatch Logs. For more information about sending command output to CloudWatch Logs, see [Configuring Amazon CloudWatch Logs for Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-rc-setting-up-cwlogs.html). --- ##### `comment`Optional ```typescript public readonly comment: string; ``` - *Type:* string (Optional) User-defined information about the command. --- ##### `documentHash`Optional ```typescript public readonly documentHash: string; ``` - *Type:* string (Optional) The hash for the document. --- ##### `documentHashType`Optional ```typescript public readonly documentHashType: string; ``` - *Type:* string (Optional) The type of the hash. --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: number; ``` - *Type:* number (Optional) The maximum concurrency. --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: number; ``` - *Type:* number (Optional) The maximum errors. --- ##### `notificationConfig`Optional ```typescript public readonly notificationConfig: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Optional) The configurations for sending notifications. --- ##### `outputS3BucketName`Optional ```typescript public readonly outputS3BucketName: string; ``` - *Type:* string (Optional) The name of the S3 bucket for command output responses. --- ##### `outputS3KeyPrefix`Optional ```typescript public readonly outputS3KeyPrefix: string; ``` - *Type:* string (Optional) The prefix. --- ##### `parameters`Optional ```typescript public readonly parameters: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Optional) The required and optional parameters specified in the document. --- ##### `serviceRoleArn`Optional ```typescript public readonly serviceRoleArn: string; ``` - *Type:* string (Optional) The ARN of the AWS Identity and Access Management (IAM) role. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number (Optional) The amount of time in seconds to wait for a command to deliver to the AWS Systems Manager SSM Agent on an instance. If the command isn't received by the SSM Agent on the instance before the value specified is reached, then the status of the command changes to Delivery Timed Out. --- ### RunCommandSimulationProps Properties for RunCommandStep. #### Initializer ```typescript import { RunCommandSimulationProps } from '@cdklabs/cdk-ssm-documents' const runCommandSimulationProps: RunCommandSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | runCommandHook | IRunCommandHook | Hook for simulating aws:runCommand. | --- ##### `runCommandHook`Required ```typescript public readonly runCommandHook: IRunCommandHook; ``` - *Type:* IRunCommandHook - *Default:* Uses AWS API to execute the document remotely. Hook for simulating aws:runCommand. --- ### RunCommandStepProps Properties for RunCommandStep. #### Initializer ```typescript import { RunCommandStepProps } from '@cdklabs/cdk-ssm-documents' const runCommandStepProps: RunCommandStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | documentName | IStringVariable | If the Command type document is owned by you or AWS, specify the name of the document. | | targets | IStringListVariable \| IMapListVariable | The instance IDs where you want the command to run. You can specify a maximum of 50 IDs. | | cloudWatchOutputConfig | IStringMapVariable | (Optional) Configuration options for sending command output to Amazon CloudWatch Logs. | | commandTimeoutSeconds | INumberVariable | (Optional) The amount of time in seconds to wait for a command to deliver to the AWS Systems Manager SSM Agent on an instance. | | comment | IStringVariable | (Optional) User-defined information about the command. | | documentHash | IStringVariable | (Optional) The hash for the document. | | documentHashType | IDocumentHashTypeVariable | (Optional) The type of the hash. | | maxConcurrency | INumberVariable | (Optional) The maximum concurrency. | | maxErrors | INumberVariable | (Optional) The maximum errors. | | notificationConfig | IStringMapVariable | (Optional) The configurations for sending notifications. | | outputS3BucketName | IStringVariable | (Optional) The name of the S3 bucket for command output responses. | | outputS3KeyPrefix | IStringVariable | (Optional) The prefix. | | parameters | IStringMapVariable | (Optional) The required and optional parameters specified in the document. | | serviceRoleArn | IStringVariable | (Optional) The ARN of the AWS Identity and Access Management (IAM) role. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `documentName`Required ```typescript public readonly documentName: IStringVariable; ``` - *Type:* IStringVariable If the Command type document is owned by you or AWS, specify the name of the document. If you're using a document shared with you by a different AWS account, specify the Amazon Resource Name (ARN) of the document. --- ##### `targets`Required ```typescript public readonly targets: IStringListVariable | IMapListVariable; ``` - *Type:* IStringListVariable | IMapListVariable The instance IDs where you want the command to run. You can specify a maximum of 50 IDs. You can also use the pseudo parameter {{ RESOURCE_ID }} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html). Another alternative is to send commands to a fleet of instances by using the Targets parameter. The Targets parameter accepts Amazon Elastic Compute Cloud (Amazon EC2) tags. For more information about how to use the Targets parameter, see [Using targets and rate controls to send commands to a fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html). --- ##### `cloudWatchOutputConfig`Optional ```typescript public readonly cloudWatchOutputConfig: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) Configuration options for sending command output to Amazon CloudWatch Logs. For more information about sending command output to CloudWatch Logs, see [Configuring Amazon CloudWatch Logs for Run Command](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-rc-setting-up-cwlogs.html). --- ##### `commandTimeoutSeconds`Optional ```typescript public readonly commandTimeoutSeconds: INumberVariable; ``` - *Type:* INumberVariable (Optional) The amount of time in seconds to wait for a command to deliver to the AWS Systems Manager SSM Agent on an instance. If the command isn't received by the SSM Agent on the instance before the value specified is reached, then the status of the command changes to Delivery Timed Out. --- ##### `comment`Optional ```typescript public readonly comment: IStringVariable; ``` - *Type:* IStringVariable (Optional) User-defined information about the command. --- ##### `documentHash`Optional ```typescript public readonly documentHash: IStringVariable; ``` - *Type:* IStringVariable (Optional) The hash for the document. --- ##### `documentHashType`Optional ```typescript public readonly documentHashType: IDocumentHashTypeVariable; ``` - *Type:* IDocumentHashTypeVariable (Optional) The type of the hash. --- ##### `maxConcurrency`Optional ```typescript public readonly maxConcurrency: INumberVariable; ``` - *Type:* INumberVariable (Optional) The maximum concurrency. --- ##### `maxErrors`Optional ```typescript public readonly maxErrors: INumberVariable; ``` - *Type:* INumberVariable (Optional) The maximum errors. --- ##### `notificationConfig`Optional ```typescript public readonly notificationConfig: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) The configurations for sending notifications. --- ##### `outputS3BucketName`Optional ```typescript public readonly outputS3BucketName: IStringVariable; ``` - *Type:* IStringVariable (Optional) The name of the S3 bucket for command output responses. --- ##### `outputS3KeyPrefix`Optional ```typescript public readonly outputS3KeyPrefix: IStringVariable; ``` - *Type:* IStringVariable (Optional) The prefix. --- ##### `parameters`Optional ```typescript public readonly parameters: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) The required and optional parameters specified in the document. --- ##### `serviceRoleArn`Optional ```typescript public readonly serviceRoleArn: IStringVariable; ``` - *Type:* IStringVariable (Optional) The ARN of the AWS Identity and Access Management (IAM) role. --- ### RunDockerActionStepProps #### Initializer ```typescript import { RunDockerActionStepProps } from '@cdklabs/cdk-ssm-documents' const runDockerActionStepProps: RunDockerActionStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | action | IStringVariable | *No description.* | | cmd | IStringVariable | *No description.* | | container | IStringVariable | *No description.* | | cpuShares | IStringVariable | *No description.* | | env | IStringVariable | *No description.* | | image | IStringVariable | *No description.* | | memory | IStringVariable | *No description.* | | publish | IStringVariable | *No description.* | | user | IStringVariable | *No description.* | | volume | IStringListVariable | *No description.* | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `action`Required ```typescript public readonly action: IStringVariable; ``` - *Type:* IStringVariable --- ##### `cmd`Optional ```typescript public readonly cmd: IStringVariable; ``` - *Type:* IStringVariable --- ##### `container`Optional ```typescript public readonly container: IStringVariable; ``` - *Type:* IStringVariable --- ##### `cpuShares`Optional ```typescript public readonly cpuShares: IStringVariable; ``` - *Type:* IStringVariable --- ##### `env`Optional ```typescript public readonly env: IStringVariable; ``` - *Type:* IStringVariable --- ##### `image`Optional ```typescript public readonly image: IStringVariable; ``` - *Type:* IStringVariable --- ##### `memory`Optional ```typescript public readonly memory: IStringVariable; ``` - *Type:* IStringVariable --- ##### `publish`Optional ```typescript public readonly publish: IStringVariable; ``` - *Type:* IStringVariable --- ##### `user`Optional ```typescript public readonly user: IStringVariable; ``` - *Type:* IStringVariable --- ##### `volume`Optional ```typescript public readonly volume: IStringListVariable; ``` - *Type:* IStringListVariable --- ### RunDocumentStepProps Properties for Run Document step. #### Initializer ```typescript import { RunDocumentStepProps } from '@cdklabs/cdk-ssm-documents' const runDocumentStepProps: RunDocumentStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | stepDocument | IRunDocumentLocation | Document info containing document type and document path. | | documentParameters | IStringMapVariable | Parameters for the document. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `stepDocument`Required ```typescript public readonly stepDocument: IRunDocumentLocation; ``` - *Type:* IRunDocumentLocation Document info containing document type and document path. Can be of type LocalRunDocument or SsmRunDocument. --- ##### `documentParameters`Optional ```typescript public readonly documentParameters: IStringMapVariable; ``` - *Type:* IStringMapVariable Parameters for the document. --- ### RunInstanceStepProps Properties for RunInstanceStep. #### Initializer ```typescript import { RunInstanceStepProps } from '@cdklabs/cdk-ssm-documents' const runInstanceStepProps: RunInstanceStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | imageId | IStringVariable | The ID of the Amazon Machine Image (AMI). | | additionalInfo | IStringVariable | (Optional) Reserved. | | blockDeviceMappings | IMapListVariable | (Optional) The block devices for the instance. | | clientToken | IStringVariable | (Optional) The identifier to ensure idempotency of the request. | | disableApiTermination | IBooleanVariable | (Optional) Turns on or turns off instance API termination. | | ebsOptimized | IBooleanVariable | (Optional) Turns on or turns off Amazon Elastic Block Store (Amazon EBS) optimization. | | iamInstanceProfileArn | IStringVariable | (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) instance profile for the instance. | | iamInstanceProfileName | IStringVariable | (Optional) The name of the IAM instance profile for the instance. | | instanceInitiatedShutdownBehavior | IStringVariable | (Optional) Indicates whether the instance stops or terminates on system shutdown. | | instanceType | IStringVariable | (Optional) The instance type. | | kernelId | IStringVariable | (Optional) The ID of the kernel. | | keyName | IStringVariable | (Optional) The name of the key pair. | | maxInstanceCount | INumberVariable | (Optional) The maximum number of instances to be launched. | | minInstanceCount | INumberVariable | (Optional) The minimum number of instances to be launched. | | monitoring | IBooleanVariable | (Optional) Turns on or turns off detailed monitoring. | | networkInterfaces | IMapListVariable | (Optional) The network interfaces. | | placement | IStringMapVariable | (Optional) The placement for the instance. | | privateIpAddress | IStringVariable | (Optional) The primary IPv4 address. | | ramdiskId | IStringVariable | (Optional) The ID of the RAM disk. | | securityGroupIds | IStringListVariable | (Optional) The IDs of the security groups for the instance. | | securityGroups | IStringListVariable | (Optional) The names of the security groups for the instance. | | subnetId | IStringVariable | (Optional) The subnet ID. | | tagSpecifications | IMapListVariable | (Optional) The tags to apply to the resources during launch. | | userData | IStringVariable | (Optional) A script provided as a string literal value. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `imageId`Required ```typescript public readonly imageId: IStringVariable; ``` - *Type:* IStringVariable The ID of the Amazon Machine Image (AMI). --- ##### `additionalInfo`Optional ```typescript public readonly additionalInfo: IStringVariable; ``` - *Type:* IStringVariable (Optional) Reserved. --- ##### `blockDeviceMappings`Optional ```typescript public readonly blockDeviceMappings: IMapListVariable; ``` - *Type:* IMapListVariable (Optional) The block devices for the instance. --- ##### `clientToken`Optional ```typescript public readonly clientToken: IStringVariable; ``` - *Type:* IStringVariable (Optional) The identifier to ensure idempotency of the request. --- ##### `disableApiTermination`Optional ```typescript public readonly disableApiTermination: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) Turns on or turns off instance API termination. --- ##### `ebsOptimized`Optional ```typescript public readonly ebsOptimized: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) Turns on or turns off Amazon Elastic Block Store (Amazon EBS) optimization. --- ##### `iamInstanceProfileArn`Optional ```typescript public readonly iamInstanceProfileArn: IStringVariable; ``` - *Type:* IStringVariable (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) instance profile for the instance. --- ##### `iamInstanceProfileName`Optional ```typescript public readonly iamInstanceProfileName: IStringVariable; ``` - *Type:* IStringVariable (Optional) The name of the IAM instance profile for the instance. --- ##### `instanceInitiatedShutdownBehavior`Optional ```typescript public readonly instanceInitiatedShutdownBehavior: IStringVariable; ``` - *Type:* IStringVariable (Optional) Indicates whether the instance stops or terminates on system shutdown. --- ##### `instanceType`Optional ```typescript public readonly instanceType: IStringVariable; ``` - *Type:* IStringVariable (Optional) The instance type. --- ##### `kernelId`Optional ```typescript public readonly kernelId: IStringVariable; ``` - *Type:* IStringVariable (Optional) The ID of the kernel. --- ##### `keyName`Optional ```typescript public readonly keyName: IStringVariable; ``` - *Type:* IStringVariable (Optional) The name of the key pair. --- ##### `maxInstanceCount`Optional ```typescript public readonly maxInstanceCount: INumberVariable; ``` - *Type:* INumberVariable (Optional) The maximum number of instances to be launched. --- ##### `minInstanceCount`Optional ```typescript public readonly minInstanceCount: INumberVariable; ``` - *Type:* INumberVariable (Optional) The minimum number of instances to be launched. --- ##### `monitoring`Optional ```typescript public readonly monitoring: IBooleanVariable; ``` - *Type:* IBooleanVariable (Optional) Turns on or turns off detailed monitoring. --- ##### `networkInterfaces`Optional ```typescript public readonly networkInterfaces: IMapListVariable; ``` - *Type:* IMapListVariable (Optional) The network interfaces. --- ##### `placement`Optional ```typescript public readonly placement: IStringMapVariable; ``` - *Type:* IStringMapVariable (Optional) The placement for the instance. --- ##### `privateIpAddress`Optional ```typescript public readonly privateIpAddress: IStringVariable; ``` - *Type:* IStringVariable (Optional) The primary IPv4 address. --- ##### `ramdiskId`Optional ```typescript public readonly ramdiskId: IStringVariable; ``` - *Type:* IStringVariable (Optional) The ID of the RAM disk. --- ##### `securityGroupIds`Optional ```typescript public readonly securityGroupIds: IStringListVariable; ``` - *Type:* IStringListVariable (Optional) The IDs of the security groups for the instance. --- ##### `securityGroups`Optional ```typescript public readonly securityGroups: IStringListVariable; ``` - *Type:* IStringListVariable (Optional) The names of the security groups for the instance. --- ##### `subnetId`Optional ```typescript public readonly subnetId: IStringVariable; ``` - *Type:* IStringVariable (Optional) The subnet ID. --- ##### `tagSpecifications`Optional ```typescript public readonly tagSpecifications: IMapListVariable; ``` - *Type:* IMapListVariable (Optional) The tags to apply to the resources during launch. You can only tag instances and volumes at launch. The specified tags are applied to all instances or volumes that are created during launch. To tag an instance after it has been launched, use the aws:createTags – Create tags for AWS resources action. --- ##### `userData`Optional ```typescript public readonly userData: IStringVariable; ``` - *Type:* IStringVariable (Optional) A script provided as a string literal value. If a literal value is entered, then it must be Base64-encoded. --- ### RunPowerShellScriptStepProps Properties for runPowerShellScript step. #### Initializer ```typescript import { RunPowerShellScriptStepProps } from '@cdklabs/cdk-ssm-documents' const runPowerShellScriptStepProps: RunPowerShellScriptStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | runCommand | IStringVariable[] | Specify the commands to run or the path to an existing script on the instance. | | timeoutSeconds | number | (Optional) The time in seconds for a command to be completed before it's considered to have failed. | | workingDirectory | IStringVariable | (Optional) The path to the working directory on your instance. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `runCommand`Required ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] Specify the commands to run or the path to an existing script on the instance. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number (Optional) The time in seconds for a command to be completed before it's considered to have failed. When the timeout is reached, Systems Manager stops the command execution. --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable (Optional) The path to the working directory on your instance. --- ### RunShellScriptStepProps Properties for sleep step. #### Initializer ```typescript import { RunShellScriptStepProps } from '@cdklabs/cdk-ssm-documents' const runShellScriptStepProps: RunShellScriptStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | runCommand | IStringVariable[] | Specify the commands to run or the path to an existing script on the instance. | | timeoutSeconds | number | (Optional) The time in seconds for a command to be completed before it's considered to have failed. | | workingDirectory | IStringVariable | (Optional) The path to the working directory on your instance. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `runCommand`Required ```typescript public readonly runCommand: IStringVariable[]; ``` - *Type:* IStringVariable[] Specify the commands to run or the path to an existing script on the instance. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number (Optional) The time in seconds for a command to be completed before it's considered to have failed. When the timeout is reached, Systems Manager stops the command execution. --- ##### `workingDirectory`Optional ```typescript public readonly workingDirectory: IStringVariable; ``` - *Type:* IStringVariable (Optional) The path to the working directory on your instance. --- ### S3ContentProps Properties.json for sourceType GitHub. #### Initializer ```typescript import { S3ContentProps } from '@cdklabs/cdk-ssm-documents' const s3ContentProps: S3ContentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | IStringVariable | The URL to the file or directory you want to download. | --- ##### `path`Required ```typescript public readonly path: IStringVariable; ``` - *Type:* IStringVariable The URL to the file or directory you want to download. --- ### SimulationProps Universe of Automation and Command simulation props. #### Initializer ```typescript import { SimulationProps } from '@cdklabs/cdk-ssm-documents' const simulationProps: SimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | approveHook | IApproveHook | *No description.* | | awsInvoker | IAwsInvoker | *No description.* | | environment | IEnvironment | *No description.* | | inputObserver | IObserver | *No description.* | | outputObserver | IObserver | *No description.* | | parameterResolver | IParameterResolver | *No description.* | | pauseHook | IPauseHook | *No description.* | | runCommandHook | IRunCommandHook | *No description.* | | simulationPlatform | Platform | *No description.* | | sleepHook | ISleepHook | *No description.* | | webhook | IWebhook | *No description.* | --- ##### `approveHook`Optional ```typescript public readonly approveHook: IApproveHook; ``` - *Type:* IApproveHook --- ##### `awsInvoker`Optional ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `environment`Optional ```typescript public readonly environment: IEnvironment; ``` - *Type:* IEnvironment --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver --- ##### `parameterResolver`Optional ```typescript public readonly parameterResolver: IParameterResolver; ``` - *Type:* IParameterResolver --- ##### `pauseHook`Optional ```typescript public readonly pauseHook: IPauseHook; ``` - *Type:* IPauseHook --- ##### `runCommandHook`Optional ```typescript public readonly runCommandHook: IRunCommandHook; ``` - *Type:* IRunCommandHook --- ##### `simulationPlatform`Optional ```typescript public readonly simulationPlatform: Platform; ``` - *Type:* Platform --- ##### `sleepHook`Optional ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook --- ##### `webhook`Optional ```typescript public readonly webhook: IWebhook; ``` - *Type:* IWebhook --- ### SimulationResult Response object returned from steps. A successful response will contain the outputs expected. A failed/canceled response will contain the stackTrace. A failure will propagate up the stack unless the step is marked to succeed on failure. #### Initializer ```typescript import { SimulationResult } from '@cdklabs/cdk-ssm-documents' const simulationResult: SimulationResult = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | executedSteps | string[] | All the steps that were executed in this Simulation. | | responseCode | ResponseCode | *No description.* | | outputs | {[ key: string ]: any} | May be empty if responseCode is FAILED/CANCELLED. | | stackTrace | string | undefined if responseCode is SUCCESS. | --- ##### `executedSteps`Required ```typescript public readonly executedSteps: string[]; ``` - *Type:* string[] All the steps that were executed in this Simulation. --- ##### `responseCode`Required ```typescript public readonly responseCode: ResponseCode; ``` - *Type:* ResponseCode --- ##### `outputs`Optional ```typescript public readonly outputs: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} May be empty if responseCode is FAILED/CANCELLED. There are no outputs provided for Command steps or documents. --- ##### `stackTrace`Optional ```typescript public readonly stackTrace: string; ``` - *Type:* string undefined if responseCode is SUCCESS. --- ### SleepSimulationProps Properties for sleep step. #### Initializer ```typescript import { SleepSimulationProps } from '@cdklabs/cdk-ssm-documents' const sleepSimulationProps: SleepSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sleepHook | ISleepHook | (Optional) Whether to really perform a pause of the runtime. | --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* SleeperImpl (Optional) Whether to really perform a pause of the runtime. To override sleep behavior, inject an ISleepHook impl or use the provided MockSleep class. --- ### SleepStepProps Properties for sleep step. #### Initializer ```typescript import { SleepStepProps } from '@cdklabs/cdk-ssm-documents' const sleepStepProps: SleepStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | sleepSeconds | number | (Required) The amount of seconds to sleep for. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `sleepSeconds`Required ```typescript public readonly sleepSeconds: number; ``` - *Type:* number (Required) The amount of seconds to sleep for. May not exceed 604800. This will be used in the SSM doc as well as how long to indicate sleep to the sleepHook. --- ### SoftwareInventoryStepProps Properties of SoftwareInventory step. #### Initializer ```typescript import { SoftwareInventoryStepProps } from '@cdklabs/cdk-ssm-documents' const softwareInventoryStepProps: SoftwareInventoryStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | applications | IStringVariable | (Optional) Collect metadata for installed applications. | | awsComponents | IStringVariable | (Optional) Collect metadata for AWS components like amazon-ssm-agent. | | customInventory | IStringVariable | (Optional) Collect custom inventory data. | | files | IStringVariable | (Optional, requires SSM Agent version 2.2.64.0 or later) Collect metadata for files, including file names, the time files were created, the time files were last modified and accessed, and file sizes, to name a few. For more information about collecting file inventory, see Working with file and Windows registry. | | instanceDetailedInformation | IStringVariable | (Optional) Collect more instance information than is provided by the default inventory plugin (aws:instanceInformation), including CPU model, speed, and the number of cores, to name a few. | | networkConfig | IStringVariable | (Optional) Collect metadata for network configurations. | | services | IStringVariable | (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for service configurations. | | windowsRegistry | IStringVariable | (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect Windows Registry keys and values. You can choose a key path and collect all keys and values recursively. You can also collect a specific registry key and its value for a specific path. Inventory collects the key path, name, type, and the value. For more information about collecting Windows Registry inventory, see Working with file and Windows registry inventory. | | windowsRoles | IStringVariable | (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for Microsoft Windows role configurations. | | windowsUpdates | IStringVariable | (Optional) Collect metadata for all Windows updates. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `applications`Optional ```typescript public readonly applications: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect metadata for installed applications. --- ##### `awsComponents`Optional ```typescript public readonly awsComponents: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect metadata for AWS components like amazon-ssm-agent. --- ##### `customInventory`Optional ```typescript public readonly customInventory: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect custom inventory data. For more information about custom inventory, see Working with custom inventory --- ##### `files`Optional ```typescript public readonly files: IStringVariable; ``` - *Type:* IStringVariable (Optional, requires SSM Agent version 2.2.64.0 or later) Collect metadata for files, including file names, the time files were created, the time files were last modified and accessed, and file sizes, to name a few. For more information about collecting file inventory, see Working with file and Windows registry. --- ##### `instanceDetailedInformation`Optional ```typescript public readonly instanceDetailedInformation: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect more instance information than is provided by the default inventory plugin (aws:instanceInformation), including CPU model, speed, and the number of cores, to name a few. --- ##### `networkConfig`Optional ```typescript public readonly networkConfig: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect metadata for network configurations. --- ##### `services`Optional ```typescript public readonly services: IStringVariable; ``` - *Type:* IStringVariable (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for service configurations. --- ##### `windowsRegistry`Optional ```typescript public readonly windowsRegistry: IStringVariable; ``` - *Type:* IStringVariable (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect Windows Registry keys and values. You can choose a key path and collect all keys and values recursively. You can also collect a specific registry key and its value for a specific path. Inventory collects the key path, name, type, and the value. For more information about collecting Windows Registry inventory, see Working with file and Windows registry inventory. --- ##### `windowsRoles`Optional ```typescript public readonly windowsRoles: IStringVariable; ``` - *Type:* IStringVariable (Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for Microsoft Windows role configurations. --- ##### `windowsUpdates`Optional ```typescript public readonly windowsUpdates: IStringVariable; ``` - *Type:* IStringVariable (Optional) Collect metadata for all Windows updates. --- ### SsmAutomationProps #### Initializer ```typescript import { SsmAutomationProps } from '@cdklabs/cdk-ssm-documents' const ssmAutomationProps: SsmAutomationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | parameters | {[ key: string ]: IGenericVariable} | Specify either StringVariables or HardCodedValues. | | targetAccount | string | The account that the automation document will be run in. | --- ##### `parameters`Required ```typescript public readonly parameters: {[ key: string ]: IGenericVariable}; ``` - *Type:* {[ key: string ]: IGenericVariable} Specify either StringVariables or HardCodedValues. > [: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html](: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html) --- ##### `targetAccount`Optional ```typescript public readonly targetAccount: string; ``` - *Type:* string The account that the automation document will be run in. This can be in either the management account or an application account. > [: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-targetaccount](: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-targetaccount) --- ### SsmDocumentContentProps Properties.json for sourceType SsmDocument. #### Initializer ```typescript import { SsmDocumentContentProps } from '@cdklabs/cdk-ssm-documents' const ssmDocumentContentProps: SsmDocumentContentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentSource | DocumentSource | specify one of the following The name and version of the document in the following format: name:version. | --- ##### `documentSource`Required ```typescript public readonly documentSource: DocumentSource; ``` - *Type:* DocumentSource specify one of the following The name and version of the document in the following format: name:version. Version is optional. or The ARN for the document in the following format: arn:aws:ssm:region:account_id:document/document_name --- ### SsmDocumentProps #### Initializer ```typescript import { SsmDocumentProps } from '@cdklabs/cdk-ssm-documents' const ssmDocumentProps: SsmDocumentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assumeRole | IStringVariable | (Optional) Assume role to use for this document. | | description | string | (Optional) Description of the document. | | docInputs | Input[] | (Optional) Inputs required by the document. | | docOutputs | DocumentOutput[] | (Optional) Outputs to be emitted from the document. | | documentFormat | DocumentFormat | (Optional) Specifies whether this document should be written as YAML or JSON. | | documentName | string | (Optional) Name of the document. | | header | string | (Optional) A Header/comment to include at the start of a YAML document. | | requires | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty \| aws-cdk-lib.IResolvable[] | `AWS::SSM::Document.Requires`. | | tags | aws-cdk-lib.CfnTag[] | `AWS::SSM::Document.Tags`. | | targetType | string | `AWS::SSM::Document.TargetType`. | | updateMethod | string | If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. | | versionName | string | `AWS::SSM::Document.VersionName`. | --- ##### `assumeRole`Optional ```typescript public readonly assumeRole: IStringVariable; ``` - *Type:* IStringVariable (Optional) Assume role to use for this document. If provided, this value MUST be included as one of the documentInput names. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string (Optional) Description of the document. Defaults to the document name. --- ##### `docInputs`Optional ```typescript public readonly docInputs: Input[]; ``` - *Type:* Input[] (Optional) Inputs required by the document. --- ##### `docOutputs`Optional ```typescript public readonly docOutputs: DocumentOutput[]; ``` - *Type:* DocumentOutput[] - *Default:* [] (Optional) Outputs to be emitted from the document. The outputs are placed in a StringSet called outputs (as is done in SSM). --- ##### `documentFormat`Optional ```typescript public readonly documentFormat: DocumentFormat; ``` - *Type:* DocumentFormat - *Default:* JSON (Optional) Specifies whether this document should be written as YAML or JSON. --- ##### `documentName`Optional ```typescript public readonly documentName: string; ``` - *Type:* string (Optional) Name of the document. Will default to the id provided for the CDK node. --- ##### `header`Optional ```typescript public readonly header: string; ``` - *Type:* string (Optional) A Header/comment to include at the start of a YAML document. JSON documents do not support headers. --- ##### `requires`Optional ```typescript public readonly requires: IResolvable | DocumentRequiresProperty | IResolvable[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty | aws-cdk-lib.IResolvable[] `AWS::SSM::Document.Requires`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires) --- ##### `tags`Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] `AWS::SSM::Document.Tags`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags) --- ##### `targetType`Optional ```typescript public readonly targetType: string; ``` - *Type:* string `AWS::SSM::Document.TargetType`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype) --- ##### `updateMethod`Optional ```typescript public readonly updateMethod: string; ``` - *Type:* string If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod) --- ##### `versionName`Optional ```typescript public readonly versionName: string; ``` - *Type:* string `AWS::SSM::Document.VersionName`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname) --- ### StepProps #### Initializer ```typescript import { StepProps } from '@cdklabs/cdk-ssm-documents' const stepProps: StepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ### StringInputProps #### Initializer ```typescript import { StringInputProps } from '@cdklabs/cdk-ssm-documents' const stringInputProps: StringInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedPattern | string | (Optional) Pattern that this input value must match. | | allowedValues | string[] | (Optional) List of allowed values that this input may be. | | defaultValue | string | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | | maxChars | number | (Optional) Maximum number of chars that this input value (string) must contain. | | minChars | number | (Optional) Minimum number of chars that this input value (string) must contain. | --- ##### `allowedPattern`Optional ```typescript public readonly allowedPattern: string; ``` - *Type:* string - *Default:* undefined (Optional) Pattern that this input value must match. --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: string[]; ``` - *Type:* string[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: string; ``` - *Type:* string - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ##### `maxChars`Optional ```typescript public readonly maxChars: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of chars that this input value (string) must contain. --- ##### `minChars`Optional ```typescript public readonly minChars: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of chars that this input value (string) must contain. --- ### StringListInputProps #### Initializer ```typescript import { StringListInputProps } from '@cdklabs/cdk-ssm-documents' const stringListInputProps: StringListInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedValues | any[] | (Optional) List of allowed values that this input may be. | | defaultValue | any | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | | maxItems | number | (Optional) Maximum number of items that this input value (list) must contain. | | minItems | number | (Optional) Minimum number of items that this input value (list) must contain. | --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: any[]; ``` - *Type:* any[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: any; ``` - *Type:* any - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ##### `maxItems`Optional ```typescript public readonly maxItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of items that this input value (list) must contain. --- ##### `minItems`Optional ```typescript public readonly minItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of items that this input value (list) must contain. --- ### StringMapInputProps #### Initializer ```typescript import { StringMapInputProps } from '@cdklabs/cdk-ssm-documents' const stringMapInputProps: StringMapInputProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowedValues | any[] | (Optional) List of allowed values that this input may be. | | defaultValue | any | (Optional) Default value to use for this input if not specified when invoking the document. | | description | string | (Optional) The description of the input. | | maxItems | number | (Optional) Maximum number of items that this input value (list) must contain. | | minItems | number | (Optional) Minimum number of items that this input value (list) must contain. | --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: any[]; ``` - *Type:* any[] - *Default:* undefined (Optional) List of allowed values that this input may be. --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: any; ``` - *Type:* any - *Default:* undefined (Optional) Default value to use for this input if not specified when invoking the document. --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* name (Optional) The description of the input. --- ##### `maxItems`Optional ```typescript public readonly maxItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Maximum number of items that this input value (list) must contain. --- ##### `minItems`Optional ```typescript public readonly minItems: number; ``` - *Type:* number - *Default:* undefined (Optional) Minimum number of items that this input value (list) must contain. --- ### UpdateAgentStepProps Properties UpdateAgent step. #### Initializer ```typescript import { UpdateAgentStepProps } from '@cdklabs/cdk-ssm-documents' const updateAgentStepProps: UpdateAgentStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | agentName | IStringVariable | EC2Config. | | allowDowngrade | IBooleanVariable | Allow the EC2Config service to be downgraded to an earlier version. | | source | IStringVariable | Must use one and only one of source or sourceRegion. | | sourceRegion | string | Must use one and only one of source or sourceRegion. | | targetVersion | IStringVariable | A specific version of the EC2Config service to install. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `agentName`Optional ```typescript public readonly agentName: IStringVariable; ``` - *Type:* IStringVariable - *Default:* EC2Config EC2Config. This is the name of the agent that runs the EC2Config service. --- ##### `allowDowngrade`Optional ```typescript public readonly allowDowngrade: IBooleanVariable; ``` - *Type:* IBooleanVariable Allow the EC2Config service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version. --- ##### `source`Optional ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable Must use one and only one of source or sourceRegion. The location where Systems Manager copies the version of EC2Config to install. You can't change this location. --- ##### `sourceRegion`Optional ```typescript public readonly sourceRegion: string; ``` - *Type:* string Must use one and only one of source or sourceRegion. If source is provided it will be used as is. If sourceRegion is provided it will populate source with https://s3.{sourceRegion}.amazonaws.com/aws-ssm-{sourceRegion}/manifest.json --- ##### `targetVersion`Optional ```typescript public readonly targetVersion: IStringVariable; ``` - *Type:* IStringVariable A specific version of the EC2Config service to install. If not specified, the service will be updated to the latest version. --- ### UpdateSSMAgentStepProps Properties UpdateAgent step. #### Initializer ```typescript import { UpdateSSMAgentStepProps } from '@cdklabs/cdk-ssm-documents' const updateSSMAgentStepProps: UpdateSSMAgentStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | exitOnFailure | boolean | (Optional) Whether to exit the document execution after failed execution of this step. | | exitOnSuccess | boolean | (Optional) Whether to exit the document execution after successful execution of this step. | | finallyStep | boolean | *No description.* | | markSuccessAndExitOnFailure | boolean | *No description.* | | onCancel | Step | (Optional) Step to jump to in the event that this step is cancelled. | | precondition | Precondition | (Optional) A precondition to test before execution occurrs. | | allowDowngrade | IBooleanVariable | Allow the SSM Agent to be downgraded to an earlier version. | | agentName | IStringVariable | amazon-ssm-agent. | | source | IStringVariable | Must use one and only one of source or sourceRegion. | | sourceRegion | string | Must use one and only one of source or sourceRegion. | | targetVersion | IStringVariable | A specific version of SSM Agent to install. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `exitOnFailure`Optional ```typescript public readonly exitOnFailure: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after failed execution of this step. Finally step will be run. --- ##### `exitOnSuccess`Optional ```typescript public readonly exitOnSuccess: boolean; ``` - *Type:* boolean - *Default:* false (Optional) Whether to exit the document execution after successful execution of this step. Finally step will be run. --- ##### `finallyStep`Optional ```typescript public readonly finallyStep: boolean; ``` - *Type:* boolean --- ##### `markSuccessAndExitOnFailure`Optional ```typescript public readonly markSuccessAndExitOnFailure: boolean; ``` - *Type:* boolean --- ##### `onCancel`Optional ```typescript public readonly onCancel: Step; ``` - *Type:* Step - *Default:* undefined (Optional) Step to jump to in the event that this step is cancelled. --- ##### `precondition`Optional ```typescript public readonly precondition: Precondition; ``` - *Type:* Precondition - *Default:* undefined (Optional) A precondition to test before execution occurrs. When the precondition isn't met, the command step isn't executed. --- ##### `allowDowngrade`Required ```typescript public readonly allowDowngrade: IBooleanVariable; ``` - *Type:* IBooleanVariable Allow the SSM Agent to be downgraded to an earlier version. If set to false, the agent can be upgraded to newer versions only (default). If set to true, specify the earlier version. --- ##### `agentName`Optional ```typescript public readonly agentName: IStringVariable; ``` - *Type:* IStringVariable amazon-ssm-agent. This is the name of the Systems Manager agent that processes requests and runs commands on the instance. --- ##### `source`Optional ```typescript public readonly source: IStringVariable; ``` - *Type:* IStringVariable Must use one and only one of source or sourceRegion. The location where Systems Manager copies the SSM Agent version to install. You can't change this location. --- ##### `sourceRegion`Optional ```typescript public readonly sourceRegion: string; ``` - *Type:* string Must use one and only one of source or sourceRegion. If source is provided it will be used as is. If sourceRegion is provided it will populate source with https://s3.{sourceRegion}.amazonaws.com/aws-ssm-{sourceRegion}/manifest.json --- ##### `targetVersion`Optional ```typescript public readonly targetVersion: IStringVariable; ``` - *Type:* IStringVariable A specific version of SSM Agent to install. If not specified, the agent will be updated to the latest version. --- ### WaitForResourceSimulationProps #### Initializer ```typescript import { WaitForResourceSimulationProps } from '@cdklabs/cdk-ssm-documents' const waitForResourceSimulationProps: WaitForResourceSimulationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). | | sleepHook | ISleepHook | (Optional) Hook to inject alternate ISleeper (to mock the sleep between failed invocations). | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker - *Default:* will perform a real invocation of the JavaScript AWS SDK using ReflectiveAwsInvoker class. (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook - *Default:* really perform sleep using SleeperImpl class. (Optional) Hook to inject alternate ISleeper (to mock the sleep between failed invocations). --- ### WaitForResourceStepProps #### Initializer ```typescript import { WaitForResourceStepProps } from '@cdklabs/cdk-ssm-documents' const waitForResourceStepProps: WaitForResourceStepProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | (Optional) description of the current step. | | inputObserver | IObserver | (Optional) Allows for observing the input to steps as they run. | | name | string | (Optional) Name of the current step. | | outputObserver | IObserver | (Optional) Allows for observing the output of steps as they run. | | explicitNextStep | StepRef | (Optional) explicit step to go to after this step completes. | | isEnd | boolean | Whether to stop document execution after this step. | | maxAttempts | number | (Optional) max attempts to run this step if there are failures. | | onCancel | OnCancel | (Optional) Fallback action to take in the event that this step is cancelled. | | onFailure | OnFailure | (Optional) Fallback action to take in the event that this step fails. | | timeoutSeconds | number | (Optional) timeout seconds to run this step. | | apiParams | {[ key: string ]: any} | (Required) API Params to submit with the request to the api. | | pascalCaseApi | string | (Required) The AWS api represented in PascalCase. | | service | AwsService | (Required) The AWS service to be invoked. | | javaScriptApi | string | (Optional) The api as represented the AWS JavaScript API. | | desiredValues | string[] | (Required) Value extracted from AWS response desired to be one of these desired values. | | selector | string | (Required) Json path selector to extract value from AWS response. | | sleepIntervalMillis | number | (Optional) How much time to sleep after not receiving desired response from AWS SDK. | --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* undefined (Optional) description of the current step. --- ##### `inputObserver`Optional ```typescript public readonly inputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the input to steps as they run. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string (Optional) Name of the current step. The name will be prepended onto all of the outputs emitted from this step. This name will also be used to reference this step in logs. Defaults to the id of the CDK node. --- ##### `outputObserver`Optional ```typescript public readonly outputObserver: IObserver; ``` - *Type:* IObserver - *Default:* NoopObserver (Optional) Allows for observing the output of steps as they run. --- ##### `explicitNextStep`Optional ```typescript public readonly explicitNextStep: StepRef; ``` - *Type:* StepRef - *Default:* will implicitly choose the next step in the sequence that the steps are added to the document. (Optional) explicit step to go to after this step completes. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp --- ##### `isEnd`Optional ```typescript public readonly isEnd: boolean; ``` - *Type:* boolean - *Default:* false Whether to stop document execution after this step. --- ##### `maxAttempts`Optional ```typescript public readonly maxAttempts: number; ``` - *Type:* number - *Default:* Step.DEFAULT_MAX_ATTEMPTS (Optional) max attempts to run this step if there are failures. --- ##### `onCancel`Optional ```typescript public readonly onCancel: OnCancel; ``` - *Type:* OnCancel - *Default:* undefined (Optional) Fallback action to take in the event that this step is cancelled. --- ##### `onFailure`Optional ```typescript public readonly onFailure: OnFailure; ``` - *Type:* OnFailure - *Default:* undefined (Optional) Fallback action to take in the event that this step fails. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: number; ``` - *Type:* number - *Default:* Step.DEFAULT_TIMEOUT (Optional) timeout seconds to run this step. In a simulation run, this will only be encorced after-the-fact but execution will not be stopped mid-step. --- ##### `apiParams`Required ```typescript public readonly apiParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} (Required) API Params to submit with the request to the api. You may include variables which will be substitued for inputs during step execution as such {{ INPUT }} --- *Example* ```typescript { 'VolumeIds': ['{{ EbsDescribeInstance.VolumeId }}'] } ``` ##### `pascalCaseApi`Required ```typescript public readonly pascalCaseApi: string; ``` - *Type:* string (Required) The AWS api represented in PascalCase. This value is used as-is in the SSM yaml/json. This is used as the default for javaScriptApi (see that param). --- *Example* ```typescript DescribeInstances ``` ##### `service`Required ```typescript public readonly service: AwsService; ``` - *Type:* AwsService (Required) The AWS service to be invoked. --- *Example* ```typescript AwsService.S3 ``` ##### `javaScriptApi`Optional ```typescript public readonly javaScriptApi: string; ``` - *Type:* string - *Default:* will use the camelCaseApi param and substitute the first character for lowercase by default. (Optional) The api as represented the AWS JavaScript API. This is usually lowerCamelCase. This is used in the simulation run to execute the AWS API against the JavaScript SDK. --- *Example* ```typescript describeInstances ``` ##### `desiredValues`Required ```typescript public readonly desiredValues: string[]; ``` - *Type:* string[] (Required) Value extracted from AWS response desired to be one of these desired values. --- ##### `selector`Required ```typescript public readonly selector: string; ``` - *Type:* string (Required) Json path selector to extract value from AWS response. --- ##### `sleepIntervalMillis`Optional ```typescript public readonly sleepIntervalMillis: number; ``` - *Type:* number - *Default:* 2000 millis (Optional) How much time to sleep after not receiving desired response from AWS SDK. This is only used for the run simulation. This is not used by SSM and is therefore not declared in the SSM yaml/json. --- ## Classes ### Abort #### Initializers ```typescript import { Abort } from '@cdklabs/cdk-ssm-documents' new Abort() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(_currentStep: AutomationStep): string ``` ###### `_currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a cancellation occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnCancel action. | --- ##### `abort` ```typescript import { Abort } from '@cdklabs/cdk-ssm-documents' Abort.abort() ``` To abort execution if a cancellation occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { Abort } from '@cdklabs/cdk-ssm-documents' Abort.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { Abort } from '@cdklabs/cdk-ssm-documents' Abort.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onCancel action. If you don't have a handle to the step object, use the invokeStepByName function. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { Abort } from '@cdklabs/cdk-ssm-documents' Abort.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnCancel action. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `stepName`Required - *Type:* string --- ### ActionVariable - *Implements:* IActionVariable #### Initializers ```typescript import { ActionVariable } from '@cdklabs/cdk-ssm-documents' new ActionVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { ActionVariable } from '@cdklabs/cdk-ssm-documents' ActionVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### ApiExecuteAutomationHook - *Implements:* IExecuteAutomationHook ExecuteAutomation implementation using AWS API. #### Initializers ```typescript import { ApiExecuteAutomationHook } from '@cdklabs/cdk-ssm-documents' new ApiExecuteAutomationHook(awsInvoker: IAwsInvoker, sleepHook: ISleepHook) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | *No description.* | | sleepHook | ISleepHook | *No description.* | --- ##### `awsInvoker`Required - *Type:* IAwsInvoker --- ##### `sleepHook`Required - *Type:* ISleepHook --- #### Methods | **Name** | **Description** | | --- | --- | | execute | Simulate the aws:executeAutomation. | --- ##### `execute` ```typescript public execute(props: ExecuteAutomationProps): ExecuteAutomationOutputs ``` Simulate the aws:executeAutomation. ###### `props`Required - *Type:* ExecuteAutomationProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ApiExecuteAutomationProps | *No description.* | --- ##### `props`Required ```typescript public readonly props: ApiExecuteAutomationProps; ``` - *Type:* ApiExecuteAutomationProps --- ### ApiRunCommandHook - *Implements:* IRunCommandHook RunCommand implementation using AWS API. #### Initializers ```typescript import { ApiRunCommandHook } from '@cdklabs/cdk-ssm-documents' new ApiRunCommandHook(awsInvoker: IAwsInvoker, sleepHook: ISleepHook) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | *No description.* | | sleepHook | ISleepHook | *No description.* | --- ##### `awsInvoker`Required - *Type:* IAwsInvoker --- ##### `sleepHook`Required - *Type:* ISleepHook --- #### Methods | **Name** | **Description** | | --- | --- | | execute | Simulate the aws:runCommand. | --- ##### `execute` ```typescript public execute(props: RunCommandProps): RunCommandOutputs ``` Simulate the aws:runCommand. ###### `props`Required - *Type:* RunCommandProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsInvoker | IAwsInvoker | *No description.* | | props | ApiRunCommandProps | *No description.* | | sleepHook | ISleepHook | *No description.* | --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ##### `props`Required ```typescript public readonly props: ApiRunCommandProps; ``` - *Type:* ApiRunCommandProps --- ##### `sleepHook`Required ```typescript public readonly sleepHook: ISleepHook; ``` - *Type:* ISleepHook --- ### ApproveImpl - *Implements:* IApproveHook This IApproveHook implementation provides a real ask and waits for user input of Enter. This implementation does not work well on all exported JSII languages. Users can provide their own impl using the IAskHook interface. #### Initializers ```typescript import { ApproveImpl } from '@cdklabs/cdk-ssm-documents' new ApproveImpl() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | ask | Ask for approval. | --- ##### `ask` ```typescript public ask(approver: string): boolean ``` Ask for approval. ###### `approver`Required - *Type:* string --- ### ApproveSimulation AutomationStep implementation for aws:approve https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-approve.html. #### Initializers ```typescript import { ApproveSimulation } from '@cdklabs/cdk-ssm-documents' new ApproveSimulation(step: ApproveStep, props: ApproveSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | ApproveStep | *No description.* | | props | ApproveSimulationProps | *No description.* | --- ##### `step`Required - *Type:* ApproveStep --- ##### `props`Required - *Type:* ApproveSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | May perform a real approval ask based on the params used during instance creation. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` May perform a real approval ask based on the params used during instance creation. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | | approveHook | IApproveHook | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `approveHook`Required ```typescript public readonly approveHook: IApproveHook; ``` - *Type:* IApproveHook --- ### ArnDoc #### Initializers ```typescript import { ArnDoc } from '@cdklabs/cdk-ssm-documents' new ArnDoc(arn: IStringVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | arn | IStringVariable | *No description.* | --- ##### `arn`Required - *Type:* IStringVariable --- #### Methods | **Name** | **Description** | | --- | --- | | formatRequest | *No description.* | | requiredInputs | *No description.* | --- ##### `formatRequest` ```typescript public formatRequest(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | fromArn | *No description.* | | fromName | *No description.* | --- ##### `fromArn` ```typescript import { ArnDoc } from '@cdklabs/cdk-ssm-documents' ArnDoc.fromArn(arn: IStringVariable) ``` ###### `arn`Required - *Type:* IStringVariable --- ##### `fromName` ```typescript import { ArnDoc } from '@cdklabs/cdk-ssm-documents' ArnDoc.fromName(name: IStringVariable, version?: IStringVariable) ``` ###### `name`Required - *Type:* IStringVariable --- ###### `version`Optional - *Type:* IStringVariable --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | arn | IStringVariable | *No description.* | --- ##### `arn`Required ```typescript public readonly arn: IStringVariable; ``` - *Type:* IStringVariable --- ### AssertAwsResourceSimulation AutomationStep implementation of aws:assertAwsResourceProperty. https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-assertAwsResourceProperty.html #### Initializers ```typescript import { AssertAwsResourceSimulation } from '@cdklabs/cdk-ssm-documents' new AssertAwsResourceSimulation(step: AssertAwsResourceStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AssertAwsResourceStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* AssertAwsResourceStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | If the value found matches one of the desiredValues, then this function returns. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` If the value found matches one of the desiredValues, then this function returns. Otherwise it throws. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### AuthMethod #### Initializers ```typescript import { AuthMethod } from '@cdklabs/cdk-ssm-documents' new AuthMethod() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | requiredInputs | *No description.* | | toEntry | *No description.* | --- ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` ##### `toEntry` ```typescript public toEntry(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | ofBasic | *No description.* | | ofDigest | *No description.* | | ofNone | *No description.* | --- ##### `ofBasic` ```typescript import { AuthMethod } from '@cdklabs/cdk-ssm-documents' AuthMethod.ofBasic(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofDigest` ```typescript import { AuthMethod } from '@cdklabs/cdk-ssm-documents' AuthMethod.ofDigest(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofNone` ```typescript import { AuthMethod } from '@cdklabs/cdk-ssm-documents' AuthMethod.ofNone() ``` ### AutomationDocumentBuilder #### Initializers ```typescript import { AutomationDocumentBuilder } from '@cdklabs/cdk-ssm-documents' new AutomationDocumentBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | addStep | *No description.* | --- ##### `addStep` ```typescript public addStep(step: AutomationStep): void ``` ###### `step`Required - *Type:* AutomationStep --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | steps | AutomationStep[] | *No description.* | --- ##### `steps`Required ```typescript public readonly steps: AutomationStep[]; ``` - *Type:* AutomationStep[] --- ### AutomationSimulation #### Initializers ```typescript import { AutomationSimulation } from '@cdklabs/cdk-ssm-documents' new AutomationSimulation(automationDocument: AutomationDocument, props: SimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | automationDocument | AutomationDocument | *No description.* | | props | SimulationProps | *No description.* | --- ##### `automationDocument`Required - *Type:* AutomationDocument --- ##### `props`Required - *Type:* SimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | start | Starts the execution of the steps by invoking the first step. | --- ##### `start` ```typescript public start(inputs: {[ key: string ]: any}): SimulationResult ``` Starts the execution of the steps by invoking the first step. The subsequent steps will be invoked by the steps themselves. ###### `inputs`Required - *Type:* {[ key: string ]: any} all of the inputs necessary for the document to execute. --- ### AutomationSimulationBase #### Initializers ```typescript import { AutomationSimulationBase } from '@cdklabs/cdk-ssm-documents' new AutomationSimulationBase(step: AutomationStep) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AutomationStep | *No description.* | --- ##### `step`Required - *Type:* AutomationStep --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ### AutomationStepSimulation #### Initializers ```typescript import { AutomationStepSimulation } from '@cdklabs/cdk-ssm-documents' new AutomationStepSimulation(step: AutomationStep, props: AutomationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AutomationStep | *No description.* | | props | AutomationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* AutomationStep --- ##### `props`Required - *Type:* AutomationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invokes the current step on the input and will return a SimulationResult. | --- ##### `invoke` ```typescript public invoke(inputs: {[ key: string ]: any}): SimulationResult ``` Invokes the current step on the input and will return a SimulationResult. ###### `inputs`Required - *Type:* {[ key: string ]: any} must contain all of the inputs declared by the current step. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RequiredAutomationSimulationProps | *No description.* | | step | AutomationStep | *No description.* | --- ##### `props`Required ```typescript public readonly props: RequiredAutomationSimulationProps; ``` - *Type:* RequiredAutomationSimulationProps --- ##### `step`Required ```typescript public readonly step: AutomationStep; ``` - *Type:* AutomationStep --- ### AwsApiSimulation AutomationStep implementation of aws:executeAwsApi. #### Initializers ```typescript import { AwsApiSimulation } from '@cdklabs/cdk-ssm-documents' new AwsApiSimulation(step: AwsApiStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AwsApiStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* AwsApiStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | Invokes the specified service (param) with the specified api (param) with the specified apiParams (param). | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` Invokes the specified service (param) with the specified api (param) with the specified apiParams (param). This call will be invoked synchronously. The input variables in apiParams (param) specified using "{{ INPUT }}" syntax will be replaced with the inputs. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | | awsApiStep | AwsApiStep | *No description.* | | awsInvoker | IAwsInvoker | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `awsApiStep`Required ```typescript public readonly awsApiStep: AwsApiStep; ``` - *Type:* AwsApiStep --- ##### `awsInvoker`Required ```typescript public readonly awsInvoker: IAwsInvoker; ``` - *Type:* IAwsInvoker --- ### AwsService Represents an AWS service. The namespace which is meant to be used for the service declaration in SSM may be difficult to guess. The name provided for simulation may at times be different. This class provides many ready-to-use implementations of AWS services. If a service is not on the list, you can fall back to constructing this object on your own. In other words, you can reference S3 using `AwsService.S3` For a NewService, you can reference it using `new AwsService('new-service', 'NewService')`. It is risky to auto convert between namespace and javaScriptName because they are not consistent in all cases. #### Initializers ```typescript import { AwsService } from '@cdklabs/cdk-ssm-documents' new AwsService(namespace: string, javaScriptName: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | namespace | string | *No description.* | | javaScriptName | string | *No description.* | --- ##### `namespace`Required - *Type:* string --- ##### `javaScriptName`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toJSON | *No description.* | --- ##### `toJSON` ```typescript public toJSON(): string ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | javaScriptName | string | Used for simulation of service requests using the simulated execution. | | namespace | string | Used for declaration in SSM Automation document. | --- ##### `javaScriptName`Required ```typescript public readonly javaScriptName: string; ``` - *Type:* string Used for simulation of service requests using the simulated execution. --- ##### `namespace`Required ```typescript public readonly namespace: string; ``` - *Type:* string Used for declaration in SSM Automation document. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ACCESS_ANALYZER | AwsService | *No description.* | | ACCOUNT | AwsService | *No description.* | | ACM | AwsService | *No description.* | | ACMPCA | AwsService | *No description.* | | ALEXA_FOR_BUSINESS | AwsService | *No description.* | | AMP | AwsService | *No description.* | | AMPLIFY | AwsService | *No description.* | | AMPLIFY_BACKEND | AwsService | *No description.* | | AMPLIFY_UI_BUILDER | AwsService | *No description.* | | API_GATEWAY_MANAGEMENT_API | AwsService | *No description.* | | API_GATEWAY_V2 | AwsService | *No description.* | | APIGATEWAY | AwsService | *No description.* | | APP_CONFIG | AwsService | *No description.* | | APP_CONFIG_DATA | AwsService | *No description.* | | APP_INTEGRATIONS | AwsService | *No description.* | | APP_MESH | AwsService | *No description.* | | APP_RUNNER | AwsService | *No description.* | | APP_STREAM | AwsService | *No description.* | | APP_SYNC | AwsService | *No description.* | | APPFLOW | AwsService | *No description.* | | APPLICATION_AUTO_SCALING | AwsService | *No description.* | | APPLICATION_COST_PROFILER | AwsService | *No description.* | | APPLICATION_INSIGHTS | AwsService | *No description.* | | ATHENA | AwsService | *No description.* | | AUDIT_MANAGER | AwsService | *No description.* | | AUTO_SCALING | AwsService | *No description.* | | AUTO_SCALING_PLANS | AwsService | *No description.* | | BACKUP | AwsService | *No description.* | | BACKUP_GATEWAY | AwsService | *No description.* | | BACKUP_STORAGE | AwsService | *No description.* | | BATCH | AwsService | *No description.* | | BILLINGCONDUCTOR | AwsService | *No description.* | | BRAKET | AwsService | *No description.* | | BUDGETS | AwsService | *No description.* | | CHIME | AwsService | *No description.* | | CHIME_SDK_IDENTITY | AwsService | *No description.* | | CHIME_SDK_MEDIA_PIPELINES | AwsService | *No description.* | | CHIME_SDK_MEETINGS | AwsService | *No description.* | | CHIME_SDK_MESSAGING | AwsService | *No description.* | | CLOUD_CONTROL | AwsService | *No description.* | | CLOUD_DIRECTORY | AwsService | *No description.* | | CLOUD_FORMATION | AwsService | *No description.* | | CLOUD_FRONT | AwsService | *No description.* | | CLOUD_HS_M | AwsService | *No description.* | | CLOUD_HSM_V2 | AwsService | *No description.* | | CLOUD_SEARCH | AwsService | *No description.* | | CLOUD_SEARCH_DOMAIN | AwsService | *No description.* | | CLOUD_TRAIL | AwsService | *No description.* | | CLOUD_WATCH | AwsService | *No description.* | | CLOUD9 | AwsService | *No description.* | | CODE_ARTIFACT | AwsService | *No description.* | | CODE_BUILD | AwsService | *No description.* | | CODE_COMMIT | AwsService | *No description.* | | CODE_DEPLOY | AwsService | *No description.* | | CODE_GURU_PROFILER | AwsService | *No description.* | | CODE_GURU_REVIEWER | AwsService | *No description.* | | CODE_PIPELINE | AwsService | *No description.* | | CODE_STAR | AwsService | *No description.* | | CODE_STAR_NOTIFICATIONS | AwsService | *No description.* | | CODE_STARCONNECTIONS | AwsService | *No description.* | | COGNITO_IDENTITY | AwsService | *No description.* | | COGNITO_SYNC | AwsService | *No description.* | | COMPREHEND | AwsService | *No description.* | | COMPREHEND_MEDICAL | AwsService | *No description.* | | COMPUTE_OPTIMIZER | AwsService | *No description.* | | CONNECT | AwsService | *No description.* | | CONNECT_CAMPAIGNS | AwsService | *No description.* | | CONNECT_CASES | AwsService | *No description.* | | CONNECT_CONTACT_LENS | AwsService | *No description.* | | CONNECT_PARTICIPANT | AwsService | *No description.* | | CONTROL_TOWER | AwsService | *No description.* | | CUR | AwsService | *No description.* | | CUSTOMER_PROFILES | AwsService | *No description.* | | DATA_BREW | AwsService | *No description.* | | DATA_EXCHANGE | AwsService | *No description.* | | DATA_PIPELINE | AwsService | *No description.* | | DATA_SYNC | AwsService | *No description.* | | DAX | AwsService | *No description.* | | DETECTIVE | AwsService | *No description.* | | DEV_OPS_GURU | AwsService | *No description.* | | DEVICE_FARM | AwsService | *No description.* | | DIRECT_CONNECT | AwsService | *No description.* | | DISCOVERY | AwsService | *No description.* | | DLM | AwsService | *No description.* | | DMS | AwsService | *No description.* | | DOC_DB | AwsService | *No description.* | | DRS | AwsService | *No description.* | | DYNAMO_DB | AwsService | *No description.* | | DYNAMO_DB_STREAMS | AwsService | *No description.* | | EBS | AwsService | *No description.* | | EC2 | AwsService | *No description.* | | EC2_INSTANCE_CONNECT | AwsService | *No description.* | | ECR | AwsService | *No description.* | | ECRPUBLIC | AwsService | *No description.* | | ECS | AwsService | *No description.* | | EFS | AwsService | *No description.* | | EKS | AwsService | *No description.* | | ELASTI_CACHE | AwsService | *No description.* | | ELASTIC_BEANSTALK | AwsService | *No description.* | | ELASTIC_INFERENCE | AwsService | *No description.* | | ELASTIC_TRANSCODER | AwsService | *No description.* | | ELB | AwsService | *No description.* | | ELBV2 | AwsService | *No description.* | | EMR | AwsService | *No description.* | | EMRCONTAINERS | AwsService | *No description.* | | EMRSERVERLESS | AwsService | *No description.* | | ES | AwsService | *No description.* | | EVIDENTLY | AwsService | *No description.* | | FINSPACE | AwsService | *No description.* | | FINSPACEDATA | AwsService | *No description.* | | FIREHOSE | AwsService | *No description.* | | FIS | AwsService | *No description.* | | FMS | AwsService | *No description.* | | FRAUD_DETECTOR | AwsService | *No description.* | | FSX | AwsService | *No description.* | | GAME_LIFT | AwsService | *No description.* | | GAME_SPARKS | AwsService | *No description.* | | GLACIER | AwsService | *No description.* | | GLOBAL_ACCELERATOR | AwsService | *No description.* | | GLUE | AwsService | *No description.* | | GRAFANA | AwsService | *No description.* | | GREENGRASS | AwsService | *No description.* | | GREENGRASS_V2 | AwsService | *No description.* | | GROUND_STATION | AwsService | *No description.* | | GUARD_DUTY | AwsService | *No description.* | | HEALTH | AwsService | *No description.* | | HEALTH_LAKE | AwsService | *No description.* | | HONEYCODE | AwsService | *No description.* | | IAM | AwsService | *No description.* | | IDENTITY_STORE | AwsService | *No description.* | | IMAGEBUILDER | AwsService | *No description.* | | IMPORT_EXPORT | AwsService | *No description.* | | INSPECTOR | AwsService | *No description.* | | INSPECTOR2 | AwsService | *No description.* | | IO_T_ANALYTICS | AwsService | *No description.* | | IO_T1_CLICK_PROJECTS | AwsService | *No description.* | | IOT | AwsService | *No description.* | | IOT_DATA | AwsService | *No description.* | | IOT_DEVICE_ADVISOR | AwsService | *No description.* | | IOT_EVENTS | AwsService | *No description.* | | IOT_EVENTS_DATA | AwsService | *No description.* | | IOT_FLEET_HUB | AwsService | *No description.* | | IOT_FLEET_WISE | AwsService | *No description.* | | IOT_SECURE_TUNNELING | AwsService | *No description.* | | IOT_SITE_WISE | AwsService | *No description.* | | IOT_THINGS_GRAPH | AwsService | *No description.* | | IOT_TWIN_MAKER | AwsService | *No description.* | | IOT_WIRELESS | AwsService | *No description.* | | IVS | AwsService | *No description.* | | IVSCHAT | AwsService | *No description.* | | KAFKA | AwsService | *No description.* | | KAFKA_CONNECT | AwsService | *No description.* | | KENDRA | AwsService | *No description.* | | KEYSPACES | AwsService | *No description.* | | KINESIS | AwsService | *No description.* | | KINESIS_ANALYTICS | AwsService | *No description.* | | KINESIS_ANALYTICS_V2 | AwsService | *No description.* | | KINESIS_VIDEO | AwsService | *No description.* | | KINESIS_VIDEO_ARCHIVED_MEDIA | AwsService | *No description.* | | KINESIS_VIDEO_MEDIA | AwsService | *No description.* | | KMS | AwsService | *No description.* | | LAKE_FORMATION | AwsService | *No description.* | | LAMBDA | AwsService | *No description.* | | LEX_RUNTIME | AwsService | *No description.* | | LICENSE_MANAGER | AwsService | *No description.* | | LICENSE_MANAGER_USER_SUBSCRIPTIONS | AwsService | *No description.* | | LIGHTSAIL | AwsService | *No description.* | | LOCATION | AwsService | *No description.* | | LOOKOUT_EQUIPMENT | AwsService | *No description.* | | LOOKOUT_METRICS | AwsService | *No description.* | | LOOKOUT_VISION | AwsService | *No description.* | | M2 | AwsService | *No description.* | | MACHINE_LEARNING | AwsService | *No description.* | | MACIE | AwsService | *No description.* | | MACIE2 | AwsService | *No description.* | | MANAGED_BLOCKCHAIN | AwsService | *No description.* | | MARKETPLACE_CATALOG | AwsService | *No description.* | | MARKETPLACE_COMMERCE_ANALYTICS | AwsService | *No description.* | | MEDIA_CONNECT | AwsService | *No description.* | | MEDIA_CONVERT | AwsService | *No description.* | | MEDIA_LIVE | AwsService | *No description.* | | MEDIA_PACKAGE | AwsService | *No description.* | | MEDIA_PACKAGE_VOD | AwsService | *No description.* | | MEDIA_STORE | AwsService | *No description.* | | MEDIA_STORE_DATA | AwsService | *No description.* | | MEDIA_TAILOR | AwsService | *No description.* | | MEMORY_DB | AwsService | *No description.* | | MGN | AwsService | *No description.* | | MIGRATION_HUB_CONFIG | AwsService | *No description.* | | MIGRATION_HUB_ORCHESTRATOR | AwsService | *No description.* | | MIGRATION_HUB_REFACTOR_SPACES | AwsService | *No description.* | | MIGRATION_HUB_STRATEGY | AwsService | *No description.* | | MOBILE | AwsService | *No description.* | | MQ | AwsService | *No description.* | | MTURK | AwsService | *No description.* | | MWAA | AwsService | *No description.* | | NEPTUNE | AwsService | *No description.* | | NETWORK_FIREWALL | AwsService | *No description.* | | NETWORK_MANAGER | AwsService | *No description.* | | NIMBLE | AwsService | *No description.* | | OPEN_SEARCH | AwsService | *No description.* | | OPS_WORKS | AwsService | *No description.* | | OPS_WORKS_C_M | AwsService | *No description.* | | ORGANIZATIONS | AwsService | *No description.* | | OUTPOSTS | AwsService | *No description.* | | PANORAMA | AwsService | *No description.* | | PERSONALIZE | AwsService | *No description.* | | PERSONALIZE_EVENTS | AwsService | *No description.* | | PERSONALIZE_RUNTIME | AwsService | *No description.* | | PI | AwsService | *No description.* | | PINPOINT | AwsService | *No description.* | | PINPOINT_EMAIL | AwsService | *No description.* | | PINPOINT_SMS_VOICE | AwsService | *No description.* | | PINPOINT_SMS_VOICE_V2 | AwsService | *No description.* | | POLLY | AwsService | *No description.* | | PRICING | AwsService | *No description.* | | PRIVATE_NETWORKS | AwsService | *No description.* | | PROTON | AwsService | *No description.* | | QLDB | AwsService | *No description.* | | QLDB_SESSION | AwsService | *No description.* | | QUICK_SIGHT | AwsService | *No description.* | | RAM | AwsService | *No description.* | | RBIN | AwsService | *No description.* | | RDS | AwsService | *No description.* | | REDSHIFT | AwsService | *No description.* | | REDSHIFT_DATA | AwsService | *No description.* | | REDSHIFT_SERVERLESS | AwsService | *No description.* | | REKOGNITION | AwsService | *No description.* | | RESILIENCEHUB | AwsService | *No description.* | | RESOURCE_EXPLORER2 | AwsService | *No description.* | | RESOURCE_GROUPS | AwsService | *No description.* | | RESOURCE_GROUPS_TAGGING_AP_I | AwsService | *No description.* | | ROBO_MAKER | AwsService | *No description.* | | ROLES_ANYWHERE | AwsService | *No description.* | | ROUTE53 | AwsService | *No description.* | | ROUTE53_DOMAINS | AwsService | *No description.* | | ROUTE53_RECOVERY_CLUSTER | AwsService | *No description.* | | ROUTE53_RECOVERY_CONTROL_CONFIG | AwsService | *No description.* | | ROUTE53_RECOVERY_READINESS | AwsService | *No description.* | | ROUTE53_RESOLVER | AwsService | *No description.* | | RUM | AwsService | *No description.* | | S3 | AwsService | *No description.* | | S3_CONTROL | AwsService | *No description.* | | S3_OUTPOSTS | AwsService | *No description.* | | SAGE_MAKER | AwsService | *No description.* | | SAGE_MAKER_FEATURE_STORE_RUNTIME | AwsService | *No description.* | | SAGE_MAKER_RUNTIME | AwsService | *No description.* | | SAGEMAKER_EDGE | AwsService | *No description.* | | SAVINGS_PLANS | AwsService | *No description.* | | SCHEDULER | AwsService | *No description.* | | SCHEMAS | AwsService | *No description.* | | SECRETS_MANAGER | AwsService | *No description.* | | SECURITY_HUB | AwsService | *No description.* | | SERVICE_CATALOG | AwsService | *No description.* | | SERVICE_CATALOG_APP_REGISTRY | AwsService | *No description.* | | SERVICE_DISCOVERY | AwsService | *No description.* | | SERVICE_QUOTAS | AwsService | *No description.* | | SES | AwsService | *No description.* | | SES_V2 | AwsService | *No description.* | | SHIELD | AwsService | *No description.* | | SIGNER | AwsService | *No description.* | | SMS | AwsService | *No description.* | | SNOW_DEVICE_MANAGEMENT | AwsService | *No description.* | | SNOWBALL | AwsService | *No description.* | | SNS | AwsService | *No description.* | | SQS | AwsService | *No description.* | | SSM | AwsService | *No description.* | | SSM_CONTACTS | AwsService | *No description.* | | SSM_INCIDENTS | AwsService | *No description.* | | SSO | AwsService | *No description.* | | SSO_ADMIN | AwsService | *No description.* | | SSO_OIDC | AwsService | *No description.* | | STEP_FUNCTIONS | AwsService | *No description.* | | STORAGE_GATEWAY | AwsService | *No description.* | | STS | AwsService | *No description.* | | SUPPORT | AwsService | *No description.* | | SUPPORT_APP | AwsService | *No description.* | | SWF | AwsService | *No description.* | | SYNTHETICS | AwsService | *No description.* | | TEXTRACT | AwsService | *No description.* | | TIMESTREAM_QUERY | AwsService | *No description.* | | TIMESTREAM_WRITE | AwsService | *No description.* | | TRANSFER | AwsService | *No description.* | | TRANSLATE | AwsService | *No description.* | | VOICE_I_D | AwsService | *No description.* | | WAF | AwsService | *No description.* | | WAF_REGIONAL | AwsService | *No description.* | | WAF_V2 | AwsService | *No description.* | | WELL_ARCHITECTED | AwsService | *No description.* | | WISDOM | AwsService | *No description.* | | WORK_DOCS | AwsService | *No description.* | | WORK_LINK | AwsService | *No description.* | | WORK_MAIL | AwsService | *No description.* | | WORK_MAIL_MESSAGE_FLOW | AwsService | *No description.* | | WORK_SPACES | AwsService | *No description.* | | WORK_SPACES_WEB | AwsService | *No description.* | | XRAY | AwsService | *No description.* | --- ##### `ACCESS_ANALYZER`Required ```typescript public readonly ACCESS_ANALYZER: AwsService; ``` - *Type:* AwsService --- ##### `ACCOUNT`Required ```typescript public readonly ACCOUNT: AwsService; ``` - *Type:* AwsService --- ##### `ACM`Required ```typescript public readonly ACM: AwsService; ``` - *Type:* AwsService --- ##### `ACMPCA`Required ```typescript public readonly ACMPCA: AwsService; ``` - *Type:* AwsService --- ##### `ALEXA_FOR_BUSINESS`Required ```typescript public readonly ALEXA_FOR_BUSINESS: AwsService; ``` - *Type:* AwsService --- ##### `AMP`Required ```typescript public readonly AMP: AwsService; ``` - *Type:* AwsService --- ##### `AMPLIFY`Required ```typescript public readonly AMPLIFY: AwsService; ``` - *Type:* AwsService --- ##### `AMPLIFY_BACKEND`Required ```typescript public readonly AMPLIFY_BACKEND: AwsService; ``` - *Type:* AwsService --- ##### `AMPLIFY_UI_BUILDER`Required ```typescript public readonly AMPLIFY_UI_BUILDER: AwsService; ``` - *Type:* AwsService --- ##### `API_GATEWAY_MANAGEMENT_API`Required ```typescript public readonly API_GATEWAY_MANAGEMENT_API: AwsService; ``` - *Type:* AwsService --- ##### `API_GATEWAY_V2`Required ```typescript public readonly API_GATEWAY_V2: AwsService; ``` - *Type:* AwsService --- ##### `APIGATEWAY`Required ```typescript public readonly APIGATEWAY: AwsService; ``` - *Type:* AwsService --- ##### `APP_CONFIG`Required ```typescript public readonly APP_CONFIG: AwsService; ``` - *Type:* AwsService --- ##### `APP_CONFIG_DATA`Required ```typescript public readonly APP_CONFIG_DATA: AwsService; ``` - *Type:* AwsService --- ##### `APP_INTEGRATIONS`Required ```typescript public readonly APP_INTEGRATIONS: AwsService; ``` - *Type:* AwsService --- ##### `APP_MESH`Required ```typescript public readonly APP_MESH: AwsService; ``` - *Type:* AwsService --- ##### `APP_RUNNER`Required ```typescript public readonly APP_RUNNER: AwsService; ``` - *Type:* AwsService --- ##### `APP_STREAM`Required ```typescript public readonly APP_STREAM: AwsService; ``` - *Type:* AwsService --- ##### `APP_SYNC`Required ```typescript public readonly APP_SYNC: AwsService; ``` - *Type:* AwsService --- ##### `APPFLOW`Required ```typescript public readonly APPFLOW: AwsService; ``` - *Type:* AwsService --- ##### `APPLICATION_AUTO_SCALING`Required ```typescript public readonly APPLICATION_AUTO_SCALING: AwsService; ``` - *Type:* AwsService --- ##### `APPLICATION_COST_PROFILER`Required ```typescript public readonly APPLICATION_COST_PROFILER: AwsService; ``` - *Type:* AwsService --- ##### `APPLICATION_INSIGHTS`Required ```typescript public readonly APPLICATION_INSIGHTS: AwsService; ``` - *Type:* AwsService --- ##### `ATHENA`Required ```typescript public readonly ATHENA: AwsService; ``` - *Type:* AwsService --- ##### `AUDIT_MANAGER`Required ```typescript public readonly AUDIT_MANAGER: AwsService; ``` - *Type:* AwsService --- ##### `AUTO_SCALING`Required ```typescript public readonly AUTO_SCALING: AwsService; ``` - *Type:* AwsService --- ##### `AUTO_SCALING_PLANS`Required ```typescript public readonly AUTO_SCALING_PLANS: AwsService; ``` - *Type:* AwsService --- ##### `BACKUP`Required ```typescript public readonly BACKUP: AwsService; ``` - *Type:* AwsService --- ##### `BACKUP_GATEWAY`Required ```typescript public readonly BACKUP_GATEWAY: AwsService; ``` - *Type:* AwsService --- ##### `BACKUP_STORAGE`Required ```typescript public readonly BACKUP_STORAGE: AwsService; ``` - *Type:* AwsService --- ##### `BATCH`Required ```typescript public readonly BATCH: AwsService; ``` - *Type:* AwsService --- ##### `BILLINGCONDUCTOR`Required ```typescript public readonly BILLINGCONDUCTOR: AwsService; ``` - *Type:* AwsService --- ##### `BRAKET`Required ```typescript public readonly BRAKET: AwsService; ``` - *Type:* AwsService --- ##### `BUDGETS`Required ```typescript public readonly BUDGETS: AwsService; ``` - *Type:* AwsService --- ##### `CHIME`Required ```typescript public readonly CHIME: AwsService; ``` - *Type:* AwsService --- ##### `CHIME_SDK_IDENTITY`Required ```typescript public readonly CHIME_SDK_IDENTITY: AwsService; ``` - *Type:* AwsService --- ##### `CHIME_SDK_MEDIA_PIPELINES`Required ```typescript public readonly CHIME_SDK_MEDIA_PIPELINES: AwsService; ``` - *Type:* AwsService --- ##### `CHIME_SDK_MEETINGS`Required ```typescript public readonly CHIME_SDK_MEETINGS: AwsService; ``` - *Type:* AwsService --- ##### `CHIME_SDK_MESSAGING`Required ```typescript public readonly CHIME_SDK_MESSAGING: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_CONTROL`Required ```typescript public readonly CLOUD_CONTROL: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_DIRECTORY`Required ```typescript public readonly CLOUD_DIRECTORY: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_FORMATION`Required ```typescript public readonly CLOUD_FORMATION: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_FRONT`Required ```typescript public readonly CLOUD_FRONT: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_HS_M`Required ```typescript public readonly CLOUD_HS_M: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_HSM_V2`Required ```typescript public readonly CLOUD_HSM_V2: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_SEARCH`Required ```typescript public readonly CLOUD_SEARCH: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_SEARCH_DOMAIN`Required ```typescript public readonly CLOUD_SEARCH_DOMAIN: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_TRAIL`Required ```typescript public readonly CLOUD_TRAIL: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD_WATCH`Required ```typescript public readonly CLOUD_WATCH: AwsService; ``` - *Type:* AwsService --- ##### `CLOUD9`Required ```typescript public readonly CLOUD9: AwsService; ``` - *Type:* AwsService --- ##### `CODE_ARTIFACT`Required ```typescript public readonly CODE_ARTIFACT: AwsService; ``` - *Type:* AwsService --- ##### `CODE_BUILD`Required ```typescript public readonly CODE_BUILD: AwsService; ``` - *Type:* AwsService --- ##### `CODE_COMMIT`Required ```typescript public readonly CODE_COMMIT: AwsService; ``` - *Type:* AwsService --- ##### `CODE_DEPLOY`Required ```typescript public readonly CODE_DEPLOY: AwsService; ``` - *Type:* AwsService --- ##### `CODE_GURU_PROFILER`Required ```typescript public readonly CODE_GURU_PROFILER: AwsService; ``` - *Type:* AwsService --- ##### `CODE_GURU_REVIEWER`Required ```typescript public readonly CODE_GURU_REVIEWER: AwsService; ``` - *Type:* AwsService --- ##### `CODE_PIPELINE`Required ```typescript public readonly CODE_PIPELINE: AwsService; ``` - *Type:* AwsService --- ##### `CODE_STAR`Required ```typescript public readonly CODE_STAR: AwsService; ``` - *Type:* AwsService --- ##### `CODE_STAR_NOTIFICATIONS`Required ```typescript public readonly CODE_STAR_NOTIFICATIONS: AwsService; ``` - *Type:* AwsService --- ##### `CODE_STARCONNECTIONS`Required ```typescript public readonly CODE_STARCONNECTIONS: AwsService; ``` - *Type:* AwsService --- ##### `COGNITO_IDENTITY`Required ```typescript public readonly COGNITO_IDENTITY: AwsService; ``` - *Type:* AwsService --- ##### `COGNITO_SYNC`Required ```typescript public readonly COGNITO_SYNC: AwsService; ``` - *Type:* AwsService --- ##### `COMPREHEND`Required ```typescript public readonly COMPREHEND: AwsService; ``` - *Type:* AwsService --- ##### `COMPREHEND_MEDICAL`Required ```typescript public readonly COMPREHEND_MEDICAL: AwsService; ``` - *Type:* AwsService --- ##### `COMPUTE_OPTIMIZER`Required ```typescript public readonly COMPUTE_OPTIMIZER: AwsService; ``` - *Type:* AwsService --- ##### `CONNECT`Required ```typescript public readonly CONNECT: AwsService; ``` - *Type:* AwsService --- ##### `CONNECT_CAMPAIGNS`Required ```typescript public readonly CONNECT_CAMPAIGNS: AwsService; ``` - *Type:* AwsService --- ##### `CONNECT_CASES`Required ```typescript public readonly CONNECT_CASES: AwsService; ``` - *Type:* AwsService --- ##### `CONNECT_CONTACT_LENS`Required ```typescript public readonly CONNECT_CONTACT_LENS: AwsService; ``` - *Type:* AwsService --- ##### `CONNECT_PARTICIPANT`Required ```typescript public readonly CONNECT_PARTICIPANT: AwsService; ``` - *Type:* AwsService --- ##### `CONTROL_TOWER`Required ```typescript public readonly CONTROL_TOWER: AwsService; ``` - *Type:* AwsService --- ##### `CUR`Required ```typescript public readonly CUR: AwsService; ``` - *Type:* AwsService --- ##### `CUSTOMER_PROFILES`Required ```typescript public readonly CUSTOMER_PROFILES: AwsService; ``` - *Type:* AwsService --- ##### `DATA_BREW`Required ```typescript public readonly DATA_BREW: AwsService; ``` - *Type:* AwsService --- ##### `DATA_EXCHANGE`Required ```typescript public readonly DATA_EXCHANGE: AwsService; ``` - *Type:* AwsService --- ##### `DATA_PIPELINE`Required ```typescript public readonly DATA_PIPELINE: AwsService; ``` - *Type:* AwsService --- ##### `DATA_SYNC`Required ```typescript public readonly DATA_SYNC: AwsService; ``` - *Type:* AwsService --- ##### `DAX`Required ```typescript public readonly DAX: AwsService; ``` - *Type:* AwsService --- ##### `DETECTIVE`Required ```typescript public readonly DETECTIVE: AwsService; ``` - *Type:* AwsService --- ##### `DEV_OPS_GURU`Required ```typescript public readonly DEV_OPS_GURU: AwsService; ``` - *Type:* AwsService --- ##### `DEVICE_FARM`Required ```typescript public readonly DEVICE_FARM: AwsService; ``` - *Type:* AwsService --- ##### `DIRECT_CONNECT`Required ```typescript public readonly DIRECT_CONNECT: AwsService; ``` - *Type:* AwsService --- ##### `DISCOVERY`Required ```typescript public readonly DISCOVERY: AwsService; ``` - *Type:* AwsService --- ##### `DLM`Required ```typescript public readonly DLM: AwsService; ``` - *Type:* AwsService --- ##### `DMS`Required ```typescript public readonly DMS: AwsService; ``` - *Type:* AwsService --- ##### `DOC_DB`Required ```typescript public readonly DOC_DB: AwsService; ``` - *Type:* AwsService --- ##### `DRS`Required ```typescript public readonly DRS: AwsService; ``` - *Type:* AwsService --- ##### `DYNAMO_DB`Required ```typescript public readonly DYNAMO_DB: AwsService; ``` - *Type:* AwsService --- ##### `DYNAMO_DB_STREAMS`Required ```typescript public readonly DYNAMO_DB_STREAMS: AwsService; ``` - *Type:* AwsService --- ##### `EBS`Required ```typescript public readonly EBS: AwsService; ``` - *Type:* AwsService --- ##### `EC2`Required ```typescript public readonly EC2: AwsService; ``` - *Type:* AwsService --- ##### `EC2_INSTANCE_CONNECT`Required ```typescript public readonly EC2_INSTANCE_CONNECT: AwsService; ``` - *Type:* AwsService --- ##### `ECR`Required ```typescript public readonly ECR: AwsService; ``` - *Type:* AwsService --- ##### `ECRPUBLIC`Required ```typescript public readonly ECRPUBLIC: AwsService; ``` - *Type:* AwsService --- ##### `ECS`Required ```typescript public readonly ECS: AwsService; ``` - *Type:* AwsService --- ##### `EFS`Required ```typescript public readonly EFS: AwsService; ``` - *Type:* AwsService --- ##### `EKS`Required ```typescript public readonly EKS: AwsService; ``` - *Type:* AwsService --- ##### `ELASTI_CACHE`Required ```typescript public readonly ELASTI_CACHE: AwsService; ``` - *Type:* AwsService --- ##### `ELASTIC_BEANSTALK`Required ```typescript public readonly ELASTIC_BEANSTALK: AwsService; ``` - *Type:* AwsService --- ##### `ELASTIC_INFERENCE`Required ```typescript public readonly ELASTIC_INFERENCE: AwsService; ``` - *Type:* AwsService --- ##### `ELASTIC_TRANSCODER`Required ```typescript public readonly ELASTIC_TRANSCODER: AwsService; ``` - *Type:* AwsService --- ##### `ELB`Required ```typescript public readonly ELB: AwsService; ``` - *Type:* AwsService --- ##### `ELBV2`Required ```typescript public readonly ELBV2: AwsService; ``` - *Type:* AwsService --- ##### `EMR`Required ```typescript public readonly EMR: AwsService; ``` - *Type:* AwsService --- ##### `EMRCONTAINERS`Required ```typescript public readonly EMRCONTAINERS: AwsService; ``` - *Type:* AwsService --- ##### `EMRSERVERLESS`Required ```typescript public readonly EMRSERVERLESS: AwsService; ``` - *Type:* AwsService --- ##### `ES`Required ```typescript public readonly ES: AwsService; ``` - *Type:* AwsService --- ##### `EVIDENTLY`Required ```typescript public readonly EVIDENTLY: AwsService; ``` - *Type:* AwsService --- ##### `FINSPACE`Required ```typescript public readonly FINSPACE: AwsService; ``` - *Type:* AwsService --- ##### `FINSPACEDATA`Required ```typescript public readonly FINSPACEDATA: AwsService; ``` - *Type:* AwsService --- ##### `FIREHOSE`Required ```typescript public readonly FIREHOSE: AwsService; ``` - *Type:* AwsService --- ##### `FIS`Required ```typescript public readonly FIS: AwsService; ``` - *Type:* AwsService --- ##### `FMS`Required ```typescript public readonly FMS: AwsService; ``` - *Type:* AwsService --- ##### `FRAUD_DETECTOR`Required ```typescript public readonly FRAUD_DETECTOR: AwsService; ``` - *Type:* AwsService --- ##### `FSX`Required ```typescript public readonly FSX: AwsService; ``` - *Type:* AwsService --- ##### `GAME_LIFT`Required ```typescript public readonly GAME_LIFT: AwsService; ``` - *Type:* AwsService --- ##### `GAME_SPARKS`Required ```typescript public readonly GAME_SPARKS: AwsService; ``` - *Type:* AwsService --- ##### `GLACIER`Required ```typescript public readonly GLACIER: AwsService; ``` - *Type:* AwsService --- ##### `GLOBAL_ACCELERATOR`Required ```typescript public readonly GLOBAL_ACCELERATOR: AwsService; ``` - *Type:* AwsService --- ##### `GLUE`Required ```typescript public readonly GLUE: AwsService; ``` - *Type:* AwsService --- ##### `GRAFANA`Required ```typescript public readonly GRAFANA: AwsService; ``` - *Type:* AwsService --- ##### `GREENGRASS`Required ```typescript public readonly GREENGRASS: AwsService; ``` - *Type:* AwsService --- ##### `GREENGRASS_V2`Required ```typescript public readonly GREENGRASS_V2: AwsService; ``` - *Type:* AwsService --- ##### `GROUND_STATION`Required ```typescript public readonly GROUND_STATION: AwsService; ``` - *Type:* AwsService --- ##### `GUARD_DUTY`Required ```typescript public readonly GUARD_DUTY: AwsService; ``` - *Type:* AwsService --- ##### `HEALTH`Required ```typescript public readonly HEALTH: AwsService; ``` - *Type:* AwsService --- ##### `HEALTH_LAKE`Required ```typescript public readonly HEALTH_LAKE: AwsService; ``` - *Type:* AwsService --- ##### `HONEYCODE`Required ```typescript public readonly HONEYCODE: AwsService; ``` - *Type:* AwsService --- ##### `IAM`Required ```typescript public readonly IAM: AwsService; ``` - *Type:* AwsService --- ##### `IDENTITY_STORE`Required ```typescript public readonly IDENTITY_STORE: AwsService; ``` - *Type:* AwsService --- ##### `IMAGEBUILDER`Required ```typescript public readonly IMAGEBUILDER: AwsService; ``` - *Type:* AwsService --- ##### `IMPORT_EXPORT`Required ```typescript public readonly IMPORT_EXPORT: AwsService; ``` - *Type:* AwsService --- ##### `INSPECTOR`Required ```typescript public readonly INSPECTOR: AwsService; ``` - *Type:* AwsService --- ##### `INSPECTOR2`Required ```typescript public readonly INSPECTOR2: AwsService; ``` - *Type:* AwsService --- ##### `IO_T_ANALYTICS`Required ```typescript public readonly IO_T_ANALYTICS: AwsService; ``` - *Type:* AwsService --- ##### `IO_T1_CLICK_PROJECTS`Required ```typescript public readonly IO_T1_CLICK_PROJECTS: AwsService; ``` - *Type:* AwsService --- ##### `IOT`Required ```typescript public readonly IOT: AwsService; ``` - *Type:* AwsService --- ##### `IOT_DATA`Required ```typescript public readonly IOT_DATA: AwsService; ``` - *Type:* AwsService --- ##### `IOT_DEVICE_ADVISOR`Required ```typescript public readonly IOT_DEVICE_ADVISOR: AwsService; ``` - *Type:* AwsService --- ##### `IOT_EVENTS`Required ```typescript public readonly IOT_EVENTS: AwsService; ``` - *Type:* AwsService --- ##### `IOT_EVENTS_DATA`Required ```typescript public readonly IOT_EVENTS_DATA: AwsService; ``` - *Type:* AwsService --- ##### `IOT_FLEET_HUB`Required ```typescript public readonly IOT_FLEET_HUB: AwsService; ``` - *Type:* AwsService --- ##### `IOT_FLEET_WISE`Required ```typescript public readonly IOT_FLEET_WISE: AwsService; ``` - *Type:* AwsService --- ##### `IOT_SECURE_TUNNELING`Required ```typescript public readonly IOT_SECURE_TUNNELING: AwsService; ``` - *Type:* AwsService --- ##### `IOT_SITE_WISE`Required ```typescript public readonly IOT_SITE_WISE: AwsService; ``` - *Type:* AwsService --- ##### `IOT_THINGS_GRAPH`Required ```typescript public readonly IOT_THINGS_GRAPH: AwsService; ``` - *Type:* AwsService --- ##### `IOT_TWIN_MAKER`Required ```typescript public readonly IOT_TWIN_MAKER: AwsService; ``` - *Type:* AwsService --- ##### `IOT_WIRELESS`Required ```typescript public readonly IOT_WIRELESS: AwsService; ``` - *Type:* AwsService --- ##### `IVS`Required ```typescript public readonly IVS: AwsService; ``` - *Type:* AwsService --- ##### `IVSCHAT`Required ```typescript public readonly IVSCHAT: AwsService; ``` - *Type:* AwsService --- ##### `KAFKA`Required ```typescript public readonly KAFKA: AwsService; ``` - *Type:* AwsService --- ##### `KAFKA_CONNECT`Required ```typescript public readonly KAFKA_CONNECT: AwsService; ``` - *Type:* AwsService --- ##### `KENDRA`Required ```typescript public readonly KENDRA: AwsService; ``` - *Type:* AwsService --- ##### `KEYSPACES`Required ```typescript public readonly KEYSPACES: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS`Required ```typescript public readonly KINESIS: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS_ANALYTICS`Required ```typescript public readonly KINESIS_ANALYTICS: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS_ANALYTICS_V2`Required ```typescript public readonly KINESIS_ANALYTICS_V2: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS_VIDEO`Required ```typescript public readonly KINESIS_VIDEO: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS_VIDEO_ARCHIVED_MEDIA`Required ```typescript public readonly KINESIS_VIDEO_ARCHIVED_MEDIA: AwsService; ``` - *Type:* AwsService --- ##### `KINESIS_VIDEO_MEDIA`Required ```typescript public readonly KINESIS_VIDEO_MEDIA: AwsService; ``` - *Type:* AwsService --- ##### `KMS`Required ```typescript public readonly KMS: AwsService; ``` - *Type:* AwsService --- ##### `LAKE_FORMATION`Required ```typescript public readonly LAKE_FORMATION: AwsService; ``` - *Type:* AwsService --- ##### `LAMBDA`Required ```typescript public readonly LAMBDA: AwsService; ``` - *Type:* AwsService --- ##### `LEX_RUNTIME`Required ```typescript public readonly LEX_RUNTIME: AwsService; ``` - *Type:* AwsService --- ##### `LICENSE_MANAGER`Required ```typescript public readonly LICENSE_MANAGER: AwsService; ``` - *Type:* AwsService --- ##### `LICENSE_MANAGER_USER_SUBSCRIPTIONS`Required ```typescript public readonly LICENSE_MANAGER_USER_SUBSCRIPTIONS: AwsService; ``` - *Type:* AwsService --- ##### `LIGHTSAIL`Required ```typescript public readonly LIGHTSAIL: AwsService; ``` - *Type:* AwsService --- ##### `LOCATION`Required ```typescript public readonly LOCATION: AwsService; ``` - *Type:* AwsService --- ##### `LOOKOUT_EQUIPMENT`Required ```typescript public readonly LOOKOUT_EQUIPMENT: AwsService; ``` - *Type:* AwsService --- ##### `LOOKOUT_METRICS`Required ```typescript public readonly LOOKOUT_METRICS: AwsService; ``` - *Type:* AwsService --- ##### `LOOKOUT_VISION`Required ```typescript public readonly LOOKOUT_VISION: AwsService; ``` - *Type:* AwsService --- ##### `M2`Required ```typescript public readonly M2: AwsService; ``` - *Type:* AwsService --- ##### `MACHINE_LEARNING`Required ```typescript public readonly MACHINE_LEARNING: AwsService; ``` - *Type:* AwsService --- ##### `MACIE`Required ```typescript public readonly MACIE: AwsService; ``` - *Type:* AwsService --- ##### `MACIE2`Required ```typescript public readonly MACIE2: AwsService; ``` - *Type:* AwsService --- ##### `MANAGED_BLOCKCHAIN`Required ```typescript public readonly MANAGED_BLOCKCHAIN: AwsService; ``` - *Type:* AwsService --- ##### `MARKETPLACE_CATALOG`Required ```typescript public readonly MARKETPLACE_CATALOG: AwsService; ``` - *Type:* AwsService --- ##### `MARKETPLACE_COMMERCE_ANALYTICS`Required ```typescript public readonly MARKETPLACE_COMMERCE_ANALYTICS: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_CONNECT`Required ```typescript public readonly MEDIA_CONNECT: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_CONVERT`Required ```typescript public readonly MEDIA_CONVERT: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_LIVE`Required ```typescript public readonly MEDIA_LIVE: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_PACKAGE`Required ```typescript public readonly MEDIA_PACKAGE: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_PACKAGE_VOD`Required ```typescript public readonly MEDIA_PACKAGE_VOD: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_STORE`Required ```typescript public readonly MEDIA_STORE: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_STORE_DATA`Required ```typescript public readonly MEDIA_STORE_DATA: AwsService; ``` - *Type:* AwsService --- ##### `MEDIA_TAILOR`Required ```typescript public readonly MEDIA_TAILOR: AwsService; ``` - *Type:* AwsService --- ##### `MEMORY_DB`Required ```typescript public readonly MEMORY_DB: AwsService; ``` - *Type:* AwsService --- ##### `MGN`Required ```typescript public readonly MGN: AwsService; ``` - *Type:* AwsService --- ##### `MIGRATION_HUB_CONFIG`Required ```typescript public readonly MIGRATION_HUB_CONFIG: AwsService; ``` - *Type:* AwsService --- ##### `MIGRATION_HUB_ORCHESTRATOR`Required ```typescript public readonly MIGRATION_HUB_ORCHESTRATOR: AwsService; ``` - *Type:* AwsService --- ##### `MIGRATION_HUB_REFACTOR_SPACES`Required ```typescript public readonly MIGRATION_HUB_REFACTOR_SPACES: AwsService; ``` - *Type:* AwsService --- ##### `MIGRATION_HUB_STRATEGY`Required ```typescript public readonly MIGRATION_HUB_STRATEGY: AwsService; ``` - *Type:* AwsService --- ##### `MOBILE`Required ```typescript public readonly MOBILE: AwsService; ``` - *Type:* AwsService --- ##### `MQ`Required ```typescript public readonly MQ: AwsService; ``` - *Type:* AwsService --- ##### `MTURK`Required ```typescript public readonly MTURK: AwsService; ``` - *Type:* AwsService --- ##### `MWAA`Required ```typescript public readonly MWAA: AwsService; ``` - *Type:* AwsService --- ##### `NEPTUNE`Required ```typescript public readonly NEPTUNE: AwsService; ``` - *Type:* AwsService --- ##### `NETWORK_FIREWALL`Required ```typescript public readonly NETWORK_FIREWALL: AwsService; ``` - *Type:* AwsService --- ##### `NETWORK_MANAGER`Required ```typescript public readonly NETWORK_MANAGER: AwsService; ``` - *Type:* AwsService --- ##### `NIMBLE`Required ```typescript public readonly NIMBLE: AwsService; ``` - *Type:* AwsService --- ##### `OPEN_SEARCH`Required ```typescript public readonly OPEN_SEARCH: AwsService; ``` - *Type:* AwsService --- ##### `OPS_WORKS`Required ```typescript public readonly OPS_WORKS: AwsService; ``` - *Type:* AwsService --- ##### `OPS_WORKS_C_M`Required ```typescript public readonly OPS_WORKS_C_M: AwsService; ``` - *Type:* AwsService --- ##### `ORGANIZATIONS`Required ```typescript public readonly ORGANIZATIONS: AwsService; ``` - *Type:* AwsService --- ##### `OUTPOSTS`Required ```typescript public readonly OUTPOSTS: AwsService; ``` - *Type:* AwsService --- ##### `PANORAMA`Required ```typescript public readonly PANORAMA: AwsService; ``` - *Type:* AwsService --- ##### `PERSONALIZE`Required ```typescript public readonly PERSONALIZE: AwsService; ``` - *Type:* AwsService --- ##### `PERSONALIZE_EVENTS`Required ```typescript public readonly PERSONALIZE_EVENTS: AwsService; ``` - *Type:* AwsService --- ##### `PERSONALIZE_RUNTIME`Required ```typescript public readonly PERSONALIZE_RUNTIME: AwsService; ``` - *Type:* AwsService --- ##### `PI`Required ```typescript public readonly PI: AwsService; ``` - *Type:* AwsService --- ##### `PINPOINT`Required ```typescript public readonly PINPOINT: AwsService; ``` - *Type:* AwsService --- ##### `PINPOINT_EMAIL`Required ```typescript public readonly PINPOINT_EMAIL: AwsService; ``` - *Type:* AwsService --- ##### `PINPOINT_SMS_VOICE`Required ```typescript public readonly PINPOINT_SMS_VOICE: AwsService; ``` - *Type:* AwsService --- ##### `PINPOINT_SMS_VOICE_V2`Required ```typescript public readonly PINPOINT_SMS_VOICE_V2: AwsService; ``` - *Type:* AwsService --- ##### `POLLY`Required ```typescript public readonly POLLY: AwsService; ``` - *Type:* AwsService --- ##### `PRICING`Required ```typescript public readonly PRICING: AwsService; ``` - *Type:* AwsService --- ##### `PRIVATE_NETWORKS`Required ```typescript public readonly PRIVATE_NETWORKS: AwsService; ``` - *Type:* AwsService --- ##### `PROTON`Required ```typescript public readonly PROTON: AwsService; ``` - *Type:* AwsService --- ##### `QLDB`Required ```typescript public readonly QLDB: AwsService; ``` - *Type:* AwsService --- ##### `QLDB_SESSION`Required ```typescript public readonly QLDB_SESSION: AwsService; ``` - *Type:* AwsService --- ##### `QUICK_SIGHT`Required ```typescript public readonly QUICK_SIGHT: AwsService; ``` - *Type:* AwsService --- ##### `RAM`Required ```typescript public readonly RAM: AwsService; ``` - *Type:* AwsService --- ##### `RBIN`Required ```typescript public readonly RBIN: AwsService; ``` - *Type:* AwsService --- ##### `RDS`Required ```typescript public readonly RDS: AwsService; ``` - *Type:* AwsService --- ##### `REDSHIFT`Required ```typescript public readonly REDSHIFT: AwsService; ``` - *Type:* AwsService --- ##### `REDSHIFT_DATA`Required ```typescript public readonly REDSHIFT_DATA: AwsService; ``` - *Type:* AwsService --- ##### `REDSHIFT_SERVERLESS`Required ```typescript public readonly REDSHIFT_SERVERLESS: AwsService; ``` - *Type:* AwsService --- ##### `REKOGNITION`Required ```typescript public readonly REKOGNITION: AwsService; ``` - *Type:* AwsService --- ##### `RESILIENCEHUB`Required ```typescript public readonly RESILIENCEHUB: AwsService; ``` - *Type:* AwsService --- ##### `RESOURCE_EXPLORER2`Required ```typescript public readonly RESOURCE_EXPLORER2: AwsService; ``` - *Type:* AwsService --- ##### `RESOURCE_GROUPS`Required ```typescript public readonly RESOURCE_GROUPS: AwsService; ``` - *Type:* AwsService --- ##### `RESOURCE_GROUPS_TAGGING_AP_I`Required ```typescript public readonly RESOURCE_GROUPS_TAGGING_AP_I: AwsService; ``` - *Type:* AwsService --- ##### `ROBO_MAKER`Required ```typescript public readonly ROBO_MAKER: AwsService; ``` - *Type:* AwsService --- ##### `ROLES_ANYWHERE`Required ```typescript public readonly ROLES_ANYWHERE: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53`Required ```typescript public readonly ROUTE53: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53_DOMAINS`Required ```typescript public readonly ROUTE53_DOMAINS: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53_RECOVERY_CLUSTER`Required ```typescript public readonly ROUTE53_RECOVERY_CLUSTER: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53_RECOVERY_CONTROL_CONFIG`Required ```typescript public readonly ROUTE53_RECOVERY_CONTROL_CONFIG: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53_RECOVERY_READINESS`Required ```typescript public readonly ROUTE53_RECOVERY_READINESS: AwsService; ``` - *Type:* AwsService --- ##### `ROUTE53_RESOLVER`Required ```typescript public readonly ROUTE53_RESOLVER: AwsService; ``` - *Type:* AwsService --- ##### `RUM`Required ```typescript public readonly RUM: AwsService; ``` - *Type:* AwsService --- ##### `S3`Required ```typescript public readonly S3: AwsService; ``` - *Type:* AwsService --- ##### `S3_CONTROL`Required ```typescript public readonly S3_CONTROL: AwsService; ``` - *Type:* AwsService --- ##### `S3_OUTPOSTS`Required ```typescript public readonly S3_OUTPOSTS: AwsService; ``` - *Type:* AwsService --- ##### `SAGE_MAKER`Required ```typescript public readonly SAGE_MAKER: AwsService; ``` - *Type:* AwsService --- ##### `SAGE_MAKER_FEATURE_STORE_RUNTIME`Required ```typescript public readonly SAGE_MAKER_FEATURE_STORE_RUNTIME: AwsService; ``` - *Type:* AwsService --- ##### `SAGE_MAKER_RUNTIME`Required ```typescript public readonly SAGE_MAKER_RUNTIME: AwsService; ``` - *Type:* AwsService --- ##### `SAGEMAKER_EDGE`Required ```typescript public readonly SAGEMAKER_EDGE: AwsService; ``` - *Type:* AwsService --- ##### `SAVINGS_PLANS`Required ```typescript public readonly SAVINGS_PLANS: AwsService; ``` - *Type:* AwsService --- ##### `SCHEDULER`Required ```typescript public readonly SCHEDULER: AwsService; ``` - *Type:* AwsService --- ##### `SCHEMAS`Required ```typescript public readonly SCHEMAS: AwsService; ``` - *Type:* AwsService --- ##### `SECRETS_MANAGER`Required ```typescript public readonly SECRETS_MANAGER: AwsService; ``` - *Type:* AwsService --- ##### `SECURITY_HUB`Required ```typescript public readonly SECURITY_HUB: AwsService; ``` - *Type:* AwsService --- ##### `SERVICE_CATALOG`Required ```typescript public readonly SERVICE_CATALOG: AwsService; ``` - *Type:* AwsService --- ##### `SERVICE_CATALOG_APP_REGISTRY`Required ```typescript public readonly SERVICE_CATALOG_APP_REGISTRY: AwsService; ``` - *Type:* AwsService --- ##### `SERVICE_DISCOVERY`Required ```typescript public readonly SERVICE_DISCOVERY: AwsService; ``` - *Type:* AwsService --- ##### `SERVICE_QUOTAS`Required ```typescript public readonly SERVICE_QUOTAS: AwsService; ``` - *Type:* AwsService --- ##### `SES`Required ```typescript public readonly SES: AwsService; ``` - *Type:* AwsService --- ##### `SES_V2`Required ```typescript public readonly SES_V2: AwsService; ``` - *Type:* AwsService --- ##### `SHIELD`Required ```typescript public readonly SHIELD: AwsService; ``` - *Type:* AwsService --- ##### `SIGNER`Required ```typescript public readonly SIGNER: AwsService; ``` - *Type:* AwsService --- ##### `SMS`Required ```typescript public readonly SMS: AwsService; ``` - *Type:* AwsService --- ##### `SNOW_DEVICE_MANAGEMENT`Required ```typescript public readonly SNOW_DEVICE_MANAGEMENT: AwsService; ``` - *Type:* AwsService --- ##### `SNOWBALL`Required ```typescript public readonly SNOWBALL: AwsService; ``` - *Type:* AwsService --- ##### `SNS`Required ```typescript public readonly SNS: AwsService; ``` - *Type:* AwsService --- ##### `SQS`Required ```typescript public readonly SQS: AwsService; ``` - *Type:* AwsService --- ##### `SSM`Required ```typescript public readonly SSM: AwsService; ``` - *Type:* AwsService --- ##### `SSM_CONTACTS`Required ```typescript public readonly SSM_CONTACTS: AwsService; ``` - *Type:* AwsService --- ##### `SSM_INCIDENTS`Required ```typescript public readonly SSM_INCIDENTS: AwsService; ``` - *Type:* AwsService --- ##### `SSO`Required ```typescript public readonly SSO: AwsService; ``` - *Type:* AwsService --- ##### `SSO_ADMIN`Required ```typescript public readonly SSO_ADMIN: AwsService; ``` - *Type:* AwsService --- ##### `SSO_OIDC`Required ```typescript public readonly SSO_OIDC: AwsService; ``` - *Type:* AwsService --- ##### `STEP_FUNCTIONS`Required ```typescript public readonly STEP_FUNCTIONS: AwsService; ``` - *Type:* AwsService --- ##### `STORAGE_GATEWAY`Required ```typescript public readonly STORAGE_GATEWAY: AwsService; ``` - *Type:* AwsService --- ##### `STS`Required ```typescript public readonly STS: AwsService; ``` - *Type:* AwsService --- ##### `SUPPORT`Required ```typescript public readonly SUPPORT: AwsService; ``` - *Type:* AwsService --- ##### `SUPPORT_APP`Required ```typescript public readonly SUPPORT_APP: AwsService; ``` - *Type:* AwsService --- ##### `SWF`Required ```typescript public readonly SWF: AwsService; ``` - *Type:* AwsService --- ##### `SYNTHETICS`Required ```typescript public readonly SYNTHETICS: AwsService; ``` - *Type:* AwsService --- ##### `TEXTRACT`Required ```typescript public readonly TEXTRACT: AwsService; ``` - *Type:* AwsService --- ##### `TIMESTREAM_QUERY`Required ```typescript public readonly TIMESTREAM_QUERY: AwsService; ``` - *Type:* AwsService --- ##### `TIMESTREAM_WRITE`Required ```typescript public readonly TIMESTREAM_WRITE: AwsService; ``` - *Type:* AwsService --- ##### `TRANSFER`Required ```typescript public readonly TRANSFER: AwsService; ``` - *Type:* AwsService --- ##### `TRANSLATE`Required ```typescript public readonly TRANSLATE: AwsService; ``` - *Type:* AwsService --- ##### `VOICE_I_D`Required ```typescript public readonly VOICE_I_D: AwsService; ``` - *Type:* AwsService --- ##### `WAF`Required ```typescript public readonly WAF: AwsService; ``` - *Type:* AwsService --- ##### `WAF_REGIONAL`Required ```typescript public readonly WAF_REGIONAL: AwsService; ``` - *Type:* AwsService --- ##### `WAF_V2`Required ```typescript public readonly WAF_V2: AwsService; ``` - *Type:* AwsService --- ##### `WELL_ARCHITECTED`Required ```typescript public readonly WELL_ARCHITECTED: AwsService; ``` - *Type:* AwsService --- ##### `WISDOM`Required ```typescript public readonly WISDOM: AwsService; ``` - *Type:* AwsService --- ##### `WORK_DOCS`Required ```typescript public readonly WORK_DOCS: AwsService; ``` - *Type:* AwsService --- ##### `WORK_LINK`Required ```typescript public readonly WORK_LINK: AwsService; ``` - *Type:* AwsService --- ##### `WORK_MAIL`Required ```typescript public readonly WORK_MAIL: AwsService; ``` - *Type:* AwsService --- ##### `WORK_MAIL_MESSAGE_FLOW`Required ```typescript public readonly WORK_MAIL_MESSAGE_FLOW: AwsService; ``` - *Type:* AwsService --- ##### `WORK_SPACES`Required ```typescript public readonly WORK_SPACES: AwsService; ``` - *Type:* AwsService --- ##### `WORK_SPACES_WEB`Required ```typescript public readonly WORK_SPACES_WEB: AwsService; ``` - *Type:* AwsService --- ##### `XRAY`Required ```typescript public readonly XRAY: AwsService; ``` - *Type:* AwsService --- ### BooleanVariable - *Implements:* IBooleanVariable A boolean variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { BooleanVariable } from '@cdklabs/cdk-ssm-documents' new BooleanVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToBoolean | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToBoolean` ```typescript public resolveToBoolean(inputs: {[ key: string ]: any}): boolean ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { BooleanVariable } from '@cdklabs/cdk-ssm-documents' BooleanVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### BranchSimulation AutomationStep implementation of aws:branch https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-branch.html. #### Initializers ```typescript import { BranchSimulation } from '@cdklabs/cdk-ssm-documents' new BranchSimulation(step: BranchStep) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | BranchStep | *No description.* | --- ##### `step`Required - *Type:* BranchStep --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | noop. | | nextStep | Overrides invoke because control flow of execution is different than standard steps. | --- ##### `executeStep` ```typescript public executeStep(_inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` noop. The logic performed in the branch branchStep happens in the invoke() function. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(inputs: {[ key: string ]: any}): AutomationStep ``` Overrides invoke because control flow of execution is different than standard steps. Will traverse the choices until one evaluated to true; will skip to that choice. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### ChangeInstanceStateSimulation AutomationStep implemenation for aws:changeInstanceState https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-changestate.html. #### Initializers ```typescript import { ChangeInstanceStateSimulation } from '@cdklabs/cdk-ssm-documents' new ChangeInstanceStateSimulation(step: ChangeInstanceStateStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | ChangeInstanceStateStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* ChangeInstanceStateStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### Choice Choices are supplied to the BranchStep to determine under which conditions to jump to which steps. #### Initializers ```typescript import { Choice } from '@cdklabs/cdk-ssm-documents' new Choice(props: ChoiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ChoiceProps | *No description.* | --- ##### `props`Required - *Type:* ChoiceProps --- #### Methods | **Name** | **Description** | | --- | --- | | asSsmEntry | *No description.* | | evaluate | Evaluates this choice against the provided inputs. | --- ##### `asSsmEntry` ```typescript public asSsmEntry(): {[ key: string ]: any} ``` ##### `evaluate` ```typescript public evaluate(inputs: {[ key: string ]: any}): boolean ``` Evaluates this choice against the provided inputs. The value keyed on the inputToTest will be tested against the declared constant using the Operation specified. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | constant | any | *No description.* | | jumpToStepName | string | *No description.* | | operation | Operation | *No description.* | | variable | IStringVariable \| INumberVariable \| IBooleanVariable | *No description.* | --- ##### `constant`Required ```typescript public readonly constant: any; ``` - *Type:* any --- ##### `jumpToStepName`Required ```typescript public readonly jumpToStepName: string; ``` - *Type:* string --- ##### `operation`Required ```typescript public readonly operation: Operation; ``` - *Type:* Operation --- ##### `variable`Required ```typescript public readonly variable: IStringVariable | INumberVariable | IBooleanVariable; ``` - *Type:* IStringVariable | INumberVariable | IBooleanVariable --- ### CommandDocumentBuilder #### Initializers ```typescript import { CommandDocumentBuilder } from '@cdklabs/cdk-ssm-documents' new CommandDocumentBuilder() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | addStep | *No description.* | --- ##### `addStep` ```typescript public addStep(step: CommandStep): void ``` ###### `step`Required - *Type:* CommandStep --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | steps | CommandStep[] | *No description.* | --- ##### `steps`Required ```typescript public readonly steps: CommandStep[]; ``` - *Type:* CommandStep[] --- ### CommandSimulation #### Initializers ```typescript import { CommandSimulation } from '@cdklabs/cdk-ssm-documents' new CommandSimulation(commandDocument: CommandDocument, props: SimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | commandDocument | CommandDocument | *No description.* | | props | SimulationProps | *No description.* | --- ##### `commandDocument`Required - *Type:* CommandDocument --- ##### `props`Required - *Type:* SimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | start | *No description.* | --- ##### `start` ```typescript public start(inputs: {[ key: string ]: any}): SimulationResult ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ### CommandSimulationBase #### Initializers ```typescript import { CommandSimulationBase } from '@cdklabs/cdk-ssm-documents' new CommandSimulationBase() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): void ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ### CommandStepSimulation #### Initializers ```typescript import { CommandStepSimulation } from '@cdklabs/cdk-ssm-documents' new CommandStepSimulation(step: CommandStep, props: CommandSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | CommandStep | *No description.* | | props | CommandSimulationProps | *No description.* | --- ##### `step`Required - *Type:* CommandStep --- ##### `props`Required - *Type:* CommandSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invokes the current step on the input and will return a SimulationResult. | --- ##### `invoke` ```typescript public invoke(inputs: {[ key: string ]: any}): SimulationResult ``` Invokes the current step on the input and will return a SimulationResult. ###### `inputs`Required - *Type:* {[ key: string ]: any} must contain all of the inputs declared by the current step. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RequiredCommandSimulationProps | *No description.* | | step | CommandStep | *No description.* | --- ##### `props`Required ```typescript public readonly props: RequiredCommandSimulationProps; ``` - *Type:* RequiredCommandSimulationProps --- ##### `step`Required ```typescript public readonly step: CommandStep; ``` - *Type:* CommandStep --- ### Continue #### Initializers ```typescript import { Continue } from '@cdklabs/cdk-ssm-documents' new Continue() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(currentStep: AutomationStep): string ``` ###### `currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a failure occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnFailure action. | --- ##### `abort` ```typescript import { Continue } from '@cdklabs/cdk-ssm-documents' Continue.abort() ``` To abort execution if a failure occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { Continue } from '@cdklabs/cdk-ssm-documents' Continue.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { Continue } from '@cdklabs/cdk-ssm-documents' Continue.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onFailure action. If you don't have a handle to the step object, use the invokeStepByName function. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { Continue } from '@cdklabs/cdk-ssm-documents' Continue.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnFailure action. ###### `stepName`Required - *Type:* string --- ### CopyImageSimulation AutomationStep implemenation for aws:copyImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-copyimage.html. #### Initializers ```typescript import { CopyImageSimulation } from '@cdklabs/cdk-ssm-documents' new CopyImageSimulation(step: CopyImageStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | CopyImageStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* CopyImageStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### CreateImageSimulation AutomationStep implemenation for aws:createImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-create.html. #### Initializers ```typescript import { CreateImageSimulation } from '@cdklabs/cdk-ssm-documents' new CreateImageSimulation(step: CreateImageStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | CreateImageStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* CreateImageStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### CreateStackSimulation AutomationStep implementation for aws:createStack https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-createstack.html. #### Initializers ```typescript import { CreateStackSimulation } from '@cdklabs/cdk-ssm-documents' new CreateStackSimulation(step: CreateStackStep, props: CreateStackSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | CreateStackStep | *No description.* | | props | CreateStackSimulationProps | *No description.* | --- ##### `step`Required - *Type:* CreateStackStep --- ##### `props`Required - *Type:* CreateStackSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### CreateTagsSimulation AutomationStep implemenation for aws:createTags https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-createtag.html. #### Initializers ```typescript import { CreateTagsSimulation } from '@cdklabs/cdk-ssm-documents' new CreateTagsSimulation(step: CreateTagsStep, props: CreateTagsSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | CreateTagsStep | *No description.* | | props | CreateTagsSimulationProps | *No description.* | --- ##### `step`Required - *Type:* CreateTagsStep --- ##### `props`Required - *Type:* CreateTagsSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### DataType JSII does not allow functions or constants declared in an enum class directly. Therefore, interaction with DataTypeEnum happens through this class. #### Initializers ```typescript import { DataType } from '@cdklabs/cdk-ssm-documents' new DataType(dataTypeEnum: DataTypeEnum) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | dataTypeEnum | DataTypeEnum | *No description.* | --- ##### `dataTypeEnum`Required - *Type:* DataTypeEnum --- #### Methods | **Name** | **Description** | | --- | --- | | toSsmString | *No description.* | | validateType | *No description.* | --- ##### `toSsmString` ```typescript public toSsmString(): string ``` ##### `validateType` ```typescript public validateType(val: any): boolean ``` ###### `val`Required - *Type:* any --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromDataType | *No description.* | --- ##### `fromDataType` ```typescript import { DataType } from '@cdklabs/cdk-ssm-documents' DataType.fromDataType(ssmDataType: string) ``` ###### `ssmDataType`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dataTypeEnum | DataTypeEnum | *No description.* | --- ##### `dataTypeEnum`Required ```typescript public readonly dataTypeEnum: DataTypeEnum; ``` - *Type:* DataTypeEnum --- ### DeleteImageSimulation AutomationStep implementation for aws:deleteImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-delete.html. #### Initializers ```typescript import { DeleteImageSimulation } from '@cdklabs/cdk-ssm-documents' new DeleteImageSimulation(step: DeleteImageStep, props: DeleteImageSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | DeleteImageStep | *No description.* | | props | DeleteImageSimulationProps | *No description.* | --- ##### `step`Required - *Type:* DeleteImageStep --- ##### `props`Required - *Type:* DeleteImageSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### DeleteStackSimulation AutomationStep implemenation for aws:deleteStack https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-deletestack.html. #### Initializers ```typescript import { DeleteStackSimulation } from '@cdklabs/cdk-ssm-documents' new DeleteStackSimulation(step: DeleteStackStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | DeleteStackStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* DeleteStackStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### DesiredStateVariable - *Implements:* IDesiredStateVariable #### Initializers ```typescript import { DesiredStateVariable } from '@cdklabs/cdk-ssm-documents' new DesiredStateVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { DesiredStateVariable } from '@cdklabs/cdk-ssm-documents' DesiredStateVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### DictFormat - *Implements:* IStringVariable #### Initializers ```typescript import { DictFormat } from '@cdklabs/cdk-ssm-documents' new DictFormat(format: {[ key: string ]: any}) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | format | {[ key: string ]: any} | *No description.* | --- ##### `format`Required - *Type:* {[ key: string ]: any} --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | resolveToDict | *No description.* | | resolveToString | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `resolveToDict` ```typescript public resolveToDict(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | {[ key: string ]: any} | *No description.* | --- ##### `format`Required ```typescript public readonly format: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ### DockerEnvironment - *Implements:* IEnvironment Provides a Docker client against which customers can execute their commands. This utility will not download docker images, rather will create containers from images provided. You can use this rather than running your run commands against a real EC2 machine. #### Methods | **Name** | **Description** | | --- | --- | | removeContainer | Force removes the container associated with this instance. | | run | Runs commands against the docker specified during construction. | --- ##### `removeContainer` ```typescript public removeContainer(): void ``` Force removes the container associated with this instance. ##### `run` ```typescript public run(command: string): string ``` Runs commands against the docker specified during construction. This function runs synchronously. ###### `command`Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromContainer | Use an existing container against which to run commands using the run function. | | fromImage | Create a container from the provided image. | --- ##### `fromContainer` ```typescript import { DockerEnvironment } from '@cdklabs/cdk-ssm-documents' DockerEnvironment.fromContainer(containerId: string) ``` Use an existing container against which to run commands using the run function. ###### `containerId`Required - *Type:* string --- ##### `fromImage` ```typescript import { DockerEnvironment } from '@cdklabs/cdk-ssm-documents' DockerEnvironment.fromImage(image: string) ``` Create a container from the provided image. The container created will be used by this instance to run commands using the run function. ###### `image`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | containerId | string | *No description.* | --- ##### `containerId`Required ```typescript public readonly containerId: string; ``` - *Type:* string --- ### DocumentHashTypeVariable - *Implements:* IDocumentHashTypeVariable #### Initializers ```typescript import { DocumentHashTypeVariable } from '@cdklabs/cdk-ssm-documents' new DocumentHashTypeVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { DocumentHashTypeVariable } from '@cdklabs/cdk-ssm-documents' DocumentHashTypeVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### DocumentSource #### Initializers ```typescript import { DocumentSource } from '@cdklabs/cdk-ssm-documents' new DocumentSource() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | formatRequest | *No description.* | | requiredInputs | *No description.* | --- ##### `formatRequest` ```typescript public formatRequest(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | fromArn | *No description.* | | fromName | *No description.* | --- ##### `fromArn` ```typescript import { DocumentSource } from '@cdklabs/cdk-ssm-documents' DocumentSource.fromArn(arn: IStringVariable) ``` ###### `arn`Required - *Type:* IStringVariable --- ##### `fromName` ```typescript import { DocumentSource } from '@cdklabs/cdk-ssm-documents' DocumentSource.fromName(name: IStringVariable, version?: IStringVariable) ``` ###### `name`Required - *Type:* IStringVariable --- ###### `version`Optional - *Type:* IStringVariable --- ### ExecuteScriptSimulation AutomationStep implementation for aws:executeScript https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html. #### Initializers ```typescript import { ExecuteScriptSimulation } from '@cdklabs/cdk-ssm-documents' new ExecuteScriptSimulation(step: ExecuteScriptStep) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | ExecuteScriptStep | *No description.* | --- ##### `step`Required - *Type:* ExecuteScriptStep --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | Runs the simulation. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` Runs the simulation. Nests returned object into a "Payload" key to mimic SSM behavior. Switch by language and execute code based on specified language. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | | executeScriptStep | ExecuteScriptStep | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `executeScriptStep`Required ```typescript public readonly executeScriptStep: ExecuteScriptStep; ``` - *Type:* ExecuteScriptStep --- ### ExecuteStateMachineSimulation AutomationStep implementation of [aws:executeStateMachine](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeStateMachine.html). #### Initializers ```typescript import { ExecuteStateMachineSimulation } from '@cdklabs/cdk-ssm-documents' new ExecuteStateMachineSimulation(step: ExecuteStateMachineStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | ExecuteStateMachineStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* ExecuteStateMachineStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | | executeStateMachineStep | ExecuteStateMachineStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ##### `executeStateMachineStep`Required ```typescript public readonly executeStateMachineStep: ExecuteStateMachineStep; ``` - *Type:* ExecuteStateMachineStep --- ##### `props`Required ```typescript public readonly props: AwsInvocationSimulationProps; ``` - *Type:* AwsInvocationSimulationProps --- ### FileScriptCode #### Initializers ```typescript import { FileScriptCode } from '@cdklabs/cdk-ssm-documents' new FileScriptCode(fullPath: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | fullPath | string | *No description.* | --- ##### `fullPath`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | codeAsString | *No description.* | | createOrGetFile | If there is a file for this code, return it. | --- ##### `codeAsString` ```typescript public codeAsString(): string ``` ##### `createOrGetFile` ```typescript public createOrGetFile(_suffix: string): string ``` If there is a file for this code, return it. Otherwise, create a file with the specified suffix. ###### `_suffix`Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromFile | Full path to the code to execute. | | inline | Inline code to be executed. | --- ##### `fromFile` ```typescript import { FileScriptCode } from '@cdklabs/cdk-ssm-documents' FileScriptCode.fromFile(fullPath: string) ``` Full path to the code to execute. File is parsed to produce yaml/json. Simulation will execute this file using the language specified. (Attachments not yet supported) ###### `fullPath`Required - *Type:* string --- ##### `inline` ```typescript import { FileScriptCode } from '@cdklabs/cdk-ssm-documents' FileScriptCode.inline(code: string) ``` Inline code to be executed. String will be used to produce function in yaml/json. Simulation will execute the function in this string using the language specified. ###### `code`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fullPath | string | *No description.* | --- ##### `fullPath`Required ```typescript public readonly fullPath: string; ``` - *Type:* string --- ### GenericVariable - *Implements:* IGenericVariable Abstraction of SSM variables. Variables are printed as using this syntax: {{ myVariable }} To resolve a variable, you must supply the available inputs and the variable will resolve the value. #### Initializers ```typescript import { GenericVariable } from '@cdklabs/cdk-ssm-documents' new GenericVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### GitContent - *Implements:* IDownloadableContent #### Initializers ```typescript import { GitContent } from '@cdklabs/cdk-ssm-documents' new GitContent(props: GitContentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | GitContentProps | *No description.* | --- ##### `props`Required - *Type:* GitContentProps --- #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repository | IStringVariable | *No description.* | | sourceType | string | *No description.* | | branch | string | *No description.* | | commitId | string | *No description.* | | password | SecureVariable | *No description.* | | privateSshKey | SecureVariable | *No description.* | | skipHostKeyChecking | IBooleanVariable | *No description.* | | userName | SecureVariable | *No description.* | --- ##### `repository`Required ```typescript public readonly repository: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ##### `branch`Optional ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitId`Optional ```typescript public readonly commitId: string; ``` - *Type:* string --- ##### `password`Optional ```typescript public readonly password: SecureVariable; ``` - *Type:* SecureVariable --- ##### `privateSshKey`Optional ```typescript public readonly privateSshKey: SecureVariable; ``` - *Type:* SecureVariable --- ##### `skipHostKeyChecking`Optional ```typescript public readonly skipHostKeyChecking: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `userName`Optional ```typescript public readonly userName: SecureVariable; ``` - *Type:* SecureVariable --- ### GitHubContent - *Implements:* IDownloadableContent #### Initializers ```typescript import { GitHubContent } from '@cdklabs/cdk-ssm-documents' new GitHubContent(props: GitHubContentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | GitHubContentProps | *No description.* | --- ##### `props`Required - *Type:* GitHubContentProps --- #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | owner | IStringVariable | *No description.* | | path | IStringVariable | *No description.* | | repository | IStringVariable | *No description.* | | sourceType | string | *No description.* | | tokenInfo | SecureVariable | *No description.* | | branch | string | *No description.* | | commitId | string | *No description.* | --- ##### `owner`Required ```typescript public readonly owner: IStringVariable; ``` - *Type:* IStringVariable --- ##### `path`Required ```typescript public readonly path: IStringVariable; ``` - *Type:* IStringVariable --- ##### `repository`Required ```typescript public readonly repository: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ##### `tokenInfo`Required ```typescript public readonly tokenInfo: SecureVariable; ``` - *Type:* SecureVariable --- ##### `branch`Optional ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `commitId`Optional ```typescript public readonly commitId: string; ``` - *Type:* string --- ### HardCodedAction - *Implements:* IActionVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedAction } from '@cdklabs/cdk-ssm-documents' HardCodedAction.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | INSTALL | HardCodedAction | *No description.* | | UNINSTALL | HardCodedAction | *No description.* | --- ##### `INSTALL`Required ```typescript public readonly INSTALL: HardCodedAction; ``` - *Type:* HardCodedAction --- ##### `UNINSTALL`Required ```typescript public readonly UNINSTALL: HardCodedAction; ``` - *Type:* HardCodedAction --- ### HardCodedBoolean - *Implements:* IBooleanVariable A hard-coded boolean variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedBoolean } from '@cdklabs/cdk-ssm-documents' new HardCodedBoolean(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToBoolean | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToBoolean` ```typescript public resolveToBoolean(inputs: {[ key: string ]: any}): boolean ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | FALSE | HardCodedBoolean | *No description.* | | TRUE | HardCodedBoolean | *No description.* | --- ##### `FALSE`Required ```typescript public readonly FALSE: HardCodedBoolean; ``` - *Type:* HardCodedBoolean --- ##### `TRUE`Required ```typescript public readonly TRUE: HardCodedBoolean; ``` - *Type:* HardCodedBoolean --- ### HardCodedDesiredState - *Implements:* IDesiredStateVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedDesiredState } from '@cdklabs/cdk-ssm-documents' HardCodedDesiredState.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | RUNNING | HardCodedDesiredState | *No description.* | | STOPPED | HardCodedDesiredState | *No description.* | | TERMINATED | HardCodedDesiredState | *No description.* | --- ##### `RUNNING`Required ```typescript public readonly RUNNING: HardCodedDesiredState; ``` - *Type:* HardCodedDesiredState --- ##### `STOPPED`Required ```typescript public readonly STOPPED: HardCodedDesiredState; ``` - *Type:* HardCodedDesiredState --- ##### `TERMINATED`Required ```typescript public readonly TERMINATED: HardCodedDesiredState; ``` - *Type:* HardCodedDesiredState --- ### HardCodedDocumentHashType - *Implements:* IDocumentHashTypeVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedDocumentHashType } from '@cdklabs/cdk-ssm-documents' HardCodedDocumentHashType.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | SHA1 | HardCodedDocumentHashType | *No description.* | | SHA256 | HardCodedDocumentHashType | *No description.* | --- ##### `SHA1`Required ```typescript public readonly SHA1: HardCodedDocumentHashType; ``` - *Type:* HardCodedDocumentHashType --- ##### `SHA256`Required ```typescript public readonly SHA256: HardCodedDocumentHashType; ``` - *Type:* HardCodedDocumentHashType --- ### HardCodedInstallationType - *Implements:* IInstallationTypeVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedInstallationType } from '@cdklabs/cdk-ssm-documents' HardCodedInstallationType.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | IN_PLACE_UPDATE | HardCodedInstallationType | *No description.* | | UNINSTALL_AND_REINSTALL | HardCodedInstallationType | *No description.* | --- ##### `IN_PLACE_UPDATE`Required ```typescript public readonly IN_PLACE_UPDATE: HardCodedInstallationType; ``` - *Type:* HardCodedInstallationType --- ##### `UNINSTALL_AND_REINSTALL`Required ```typescript public readonly UNINSTALL_AND_REINSTALL: HardCodedInstallationType; ``` - *Type:* HardCodedInstallationType --- ### HardCodedInstallUninstallRepair - *Implements:* IInstallUninstallRepairVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedInstallUninstallRepair } from '@cdklabs/cdk-ssm-documents' HardCodedInstallUninstallRepair.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | INSTALL | HardCodedInstallUninstallRepair | *No description.* | | REPAIR | HardCodedInstallUninstallRepair | *No description.* | | UNINSTALL | HardCodedInstallUninstallRepair | *No description.* | --- ##### `INSTALL`Required ```typescript public readonly INSTALL: HardCodedInstallUninstallRepair; ``` - *Type:* HardCodedInstallUninstallRepair --- ##### `REPAIR`Required ```typescript public readonly REPAIR: HardCodedInstallUninstallRepair; ``` - *Type:* HardCodedInstallUninstallRepair --- ##### `UNINSTALL`Required ```typescript public readonly UNINSTALL: HardCodedInstallUninstallRepair; ``` - *Type:* HardCodedInstallUninstallRepair --- ### HardCodedMapList - *Implements:* IMapListVariable A hard-coded map list variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedMapList } from '@cdklabs/cdk-ssm-documents' new HardCodedMapList(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToMapList | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToMapList` ```typescript public resolveToMapList(inputs: {[ key: string ]: any}): {[ key: string ]: any}[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedMapList } from '@cdklabs/cdk-ssm-documents' HardCodedMapList.of(val: {[ key: string ]: any}[]) ``` ###### `val`Required - *Type:* {[ key: string ]: any}[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HardCodedNumber - *Implements:* INumberVariable A hard-coded number variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedNumber } from '@cdklabs/cdk-ssm-documents' new HardCodedNumber(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToNumber | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToNumber` ```typescript public resolveToNumber(inputs: {[ key: string ]: any}): number ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedNumber } from '@cdklabs/cdk-ssm-documents' HardCodedNumber.of(val: number) ``` ###### `val`Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HardCodedOnFailure - *Implements:* IOnFailureVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedOnFailure } from '@cdklabs/cdk-ssm-documents' HardCodedOnFailure.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DELETE | HardCodedOnFailure | *No description.* | | DO_NOTHING | HardCodedOnFailure | *No description.* | | ROLLBACK | HardCodedOnFailure | *No description.* | --- ##### `DELETE`Required ```typescript public readonly DELETE: HardCodedOnFailure; ``` - *Type:* HardCodedOnFailure --- ##### `DO_NOTHING`Required ```typescript public readonly DO_NOTHING: HardCodedOnFailure; ``` - *Type:* HardCodedOnFailure --- ##### `ROLLBACK`Required ```typescript public readonly ROLLBACK: HardCodedOnFailure; ``` - *Type:* HardCodedOnFailure --- ### HardCodedPackageName - *Implements:* IPackageNameVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedPackageName } from '@cdklabs/cdk-ssm-documents' HardCodedPackageName.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | AMAZON_CLOUD_WATCH_AGENT | HardCodedPackageName | *No description.* | | AWS_ENA_NETWORK_DRIVER | HardCodedPackageName | *No description.* | | AWS_SUPPORT_EC2_RESCUE | HardCodedPackageName | *No description.* | | AWS_VSS_COMPONENTS | HardCodedPackageName | *No description.* | | AWSNVME | HardCodedPackageName | *No description.* | | AWSPV_DRIVER | HardCodedPackageName | *No description.* | | CODE_DEPLOY_AGENT | HardCodedPackageName | *No description.* | --- ##### `AMAZON_CLOUD_WATCH_AGENT`Required ```typescript public readonly AMAZON_CLOUD_WATCH_AGENT: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `AWS_ENA_NETWORK_DRIVER`Required ```typescript public readonly AWS_ENA_NETWORK_DRIVER: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `AWS_SUPPORT_EC2_RESCUE`Required ```typescript public readonly AWS_SUPPORT_EC2_RESCUE: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `AWS_VSS_COMPONENTS`Required ```typescript public readonly AWS_VSS_COMPONENTS: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `AWSNVME`Required ```typescript public readonly AWSNVME: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `AWSPV_DRIVER`Required ```typescript public readonly AWSPV_DRIVER: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ##### `CODE_DEPLOY_AGENT`Required ```typescript public readonly CODE_DEPLOY_AGENT: HardCodedPackageName; ``` - *Type:* HardCodedPackageName --- ### HardCodedResourceType - *Implements:* IResourceTypeVariable #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedResourceType } from '@cdklabs/cdk-ssm-documents' HardCodedResourceType.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | EC2 | HardCodedResourceType | *No description.* | | MAINTENANCE_WINDOW | HardCodedResourceType | *No description.* | | MANAGED_INSTANCE | HardCodedResourceType | *No description.* | | PARAMETER | HardCodedResourceType | *No description.* | --- ##### `EC2`Required ```typescript public readonly EC2: HardCodedResourceType; ``` - *Type:* HardCodedResourceType --- ##### `MAINTENANCE_WINDOW`Required ```typescript public readonly MAINTENANCE_WINDOW: HardCodedResourceType; ``` - *Type:* HardCodedResourceType --- ##### `MANAGED_INSTANCE`Required ```typescript public readonly MANAGED_INSTANCE: HardCodedResourceType; ``` - *Type:* HardCodedResourceType --- ##### `PARAMETER`Required ```typescript public readonly PARAMETER: HardCodedResourceType; ``` - *Type:* HardCodedResourceType --- ### HardCodedSecureVariable A hard-coded string variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedSecureVariable } from '@cdklabs/cdk-ssm-documents' new HardCodedSecureVariable(val: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | string | *No description.* | --- ##### `val`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Static Functions | **Name** | **Description** | | --- | --- | | ofParameter | *No description.* | | ofSecureToken | *No description.* | | ofValue | *No description.* | --- ##### `ofParameter` ```typescript import { HardCodedSecureVariable } from '@cdklabs/cdk-ssm-documents' HardCodedSecureVariable.ofParameter(reference: string) ``` ###### `reference`Required - *Type:* string --- ##### `ofSecureToken` ```typescript import { HardCodedSecureVariable } from '@cdklabs/cdk-ssm-documents' HardCodedSecureVariable.ofSecureToken(secureToken: string) ``` ###### `secureToken`Required - *Type:* string --- ##### `ofValue` ```typescript import { HardCodedSecureVariable } from '@cdklabs/cdk-ssm-documents' HardCodedSecureVariable.ofValue(value: string) ``` ###### `value`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | string | *No description.* | --- ##### `val`Required ```typescript public readonly val: string; ``` - *Type:* string --- ### HardCodedString - *Implements:* IStringVariable A hard-coded string variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedString } from '@cdklabs/cdk-ssm-documents' new HardCodedString(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedString } from '@cdklabs/cdk-ssm-documents' HardCodedString.of(val: string) ``` ###### `val`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HardCodedStringList - *Implements:* IStringListVariable A hard-coded string list variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedStringList } from '@cdklabs/cdk-ssm-documents' new HardCodedStringList(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToStringList | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToStringList` ```typescript public resolveToStringList(inputs: {[ key: string ]: any}): string[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedStringList } from '@cdklabs/cdk-ssm-documents' HardCodedStringList.of(val: string[]) ``` ###### `val`Required - *Type:* string[] --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HardCodedStringMap - *Implements:* IStringMapVariable A hard-coded string map variable. Used when not dependent on step inputs. #### Initializers ```typescript import { HardCodedStringMap } from '@cdklabs/cdk-ssm-documents' new HardCodedStringMap(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToStringMap | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToStringMap` ```typescript public resolveToStringMap(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { HardCodedStringMap } from '@cdklabs/cdk-ssm-documents' HardCodedStringMap.of(val: {[ key: string ]: any}) ``` ###### `val`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HardCodedValueBase - *Implements:* IGenericVariable #### Initializers ```typescript import { HardCodedValueBase } from '@cdklabs/cdk-ssm-documents' new HardCodedValueBase(val: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required - *Type:* any --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | val | any | *No description.* | --- ##### `val`Required ```typescript public readonly val: any; ``` - *Type:* any --- ### HttpContent - *Implements:* IDownloadableContent #### Initializers ```typescript import { HttpContent } from '@cdklabs/cdk-ssm-documents' new HttpContent(props: HttpContentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | HttpContentProps | *No description.* | --- ##### `props`Required - *Type:* HttpContentProps --- #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sourceType | string | *No description.* | | url | IStringVariable | *No description.* | | allowInsecureDownload | IBooleanVariable | *No description.* | | authMethod | AuthMethod | *No description.* | --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ##### `url`Required ```typescript public readonly url: IStringVariable; ``` - *Type:* IStringVariable --- ##### `allowInsecureDownload`Optional ```typescript public readonly allowInsecureDownload: IBooleanVariable; ``` - *Type:* IBooleanVariable --- ##### `authMethod`Optional ```typescript public readonly authMethod: AuthMethod; ``` - *Type:* AuthMethod --- ### IncidentResponseAction The Action property type specifies the configuration to launch. > [: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html](: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html) #### Initializers ```typescript import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents' new IncidentResponseAction(cfnEntry: ActionProperty) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | cfnEntry | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty | *No description.* | --- ##### `cfnEntry`Required - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty --- #### Static Functions | **Name** | **Description** | | --- | --- | | ssmAutomation | Specify the AutomationDocument to use for the action property. | | ssmAutomationEscapeHatch | *No description.* | --- ##### `ssmAutomation` ```typescript import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents' IncidentResponseAction.ssmAutomation(automationDocument: AutomationDocument, role: Role, props?: SsmAutomationProps) ``` Specify the AutomationDocument to use for the action property. ###### `automationDocument`Required - *Type:* AutomationDocument --- ###### `role`Required - *Type:* aws-cdk-lib.aws_iam.Role --- ###### `props`Optional - *Type:* SsmAutomationProps --- ##### `ssmAutomationEscapeHatch` ```typescript import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents' IncidentResponseAction.ssmAutomationEscapeHatch(ssmAutomationProperty: SsmAutomationProperty) ``` ###### `ssmAutomationProperty`Required - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.SsmAutomationProperty --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cfnEntry | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty | *No description.* | --- ##### `cfnEntry`Required ```typescript public readonly cfnEntry: ActionProperty; ``` - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty --- ### IncidentTemplate Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html. #### Initializers ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' new IncidentTemplate(impact: number, title: string, props: IncidentTemplateProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | impact | number | *No description.* | | title | string | *No description.* | | props | IncidentTemplateProps | *No description.* | --- ##### `impact`Required - *Type:* number --- ##### `title`Required - *Type:* string --- ##### `props`Required - *Type:* IncidentTemplateProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | critical | Critical impact typically relates to full application failure that impacts many to all customers. | | high | High impact denotes partial application failure with impact to many customers. | | low | Low impact denotes that customers may not be impacted by the problem yet. | | medium | Medium impact denotes that the application is providing reduced service to customers. | | noImpact | No impact denotes that customers aren't currently impacted but urgent action is needed to avoid impact. | --- ##### `critical` ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' IncidentTemplate.critical(title: string, props: IncidentTemplateProps) ``` Critical impact typically relates to full application failure that impacts many to all customers. ###### `title`Required - *Type:* string --- ###### `props`Required - *Type:* IncidentTemplateProps --- ##### `high` ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' IncidentTemplate.high(title: string, props: IncidentTemplateProps) ``` High impact denotes partial application failure with impact to many customers. ###### `title`Required - *Type:* string --- ###### `props`Required - *Type:* IncidentTemplateProps --- ##### `low` ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' IncidentTemplate.low(title: string, props: IncidentTemplateProps) ``` Low impact denotes that customers may not be impacted by the problem yet. ###### `title`Required - *Type:* string --- ###### `props`Required - *Type:* IncidentTemplateProps --- ##### `medium` ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' IncidentTemplate.medium(title: string, props: IncidentTemplateProps) ``` Medium impact denotes that the application is providing reduced service to customers. ###### `title`Required - *Type:* string --- ###### `props`Required - *Type:* IncidentTemplateProps --- ##### `noImpact` ```typescript import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents' IncidentTemplate.noImpact(title: string, props: IncidentTemplateProps) ``` No impact denotes that customers aren't currently impacted but urgent action is needed to avoid impact. ###### `title`Required - *Type:* string --- ###### `props`Required - *Type:* IncidentTemplateProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cfnEntry | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.IncidentTemplateProperty | *No description.* | --- ##### `cfnEntry`Required ```typescript public readonly cfnEntry: IncidentTemplateProperty; ``` - *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.IncidentTemplateProperty --- ### InlineScriptCode #### Initializers ```typescript import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents' new InlineScriptCode(inlineCode: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | inlineCode | string | *No description.* | --- ##### `inlineCode`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | codeAsString | *No description.* | | createOrGetFile | If there is a file for this code, return it. | --- ##### `codeAsString` ```typescript public codeAsString(): string ``` ##### `createOrGetFile` ```typescript public createOrGetFile(suffix: string): string ``` If there is a file for this code, return it. Otherwise, create a file with the specified suffix. ###### `suffix`Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromFile | Full path to the code to execute. | | inline | Inline code to be executed. | --- ##### `fromFile` ```typescript import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents' InlineScriptCode.fromFile(fullPath: string) ``` Full path to the code to execute. File is parsed to produce yaml/json. Simulation will execute this file using the language specified. (Attachments not yet supported) ###### `fullPath`Required - *Type:* string --- ##### `inline` ```typescript import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents' InlineScriptCode.inline(code: string) ``` Inline code to be executed. String will be used to produce function in yaml/json. Simulation will execute the function in this string using the language specified. ###### `code`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | inlineCode | string | *No description.* | --- ##### `inlineCode`Required ```typescript public readonly inlineCode: string; ``` - *Type:* string --- ### Input #### Initializers ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' new Input(props: InputProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | InputProps | *No description.* | --- ##### `props`Required - *Type:* InputProps --- #### Methods | **Name** | **Description** | | --- | --- | | toSsm | *No description.* | | validate | *No description.* | --- ##### `toSsm` ```typescript public toSsm(): {[ key: string ]: any} ``` ##### `validate` ```typescript public validate(value: any): void ``` ###### `value`Required - *Type:* any --- #### Static Functions | **Name** | **Description** | | --- | --- | | ofSpecifiedType | *No description.* | | ofTypeBoolean | *No description.* | | ofTypeInteger | *No description.* | | ofTypeMapList | *No description.* | | ofTypeString | *No description.* | | ofTypeStringList | *No description.* | | ofTypeStringMap | *No description.* | --- ##### `ofSpecifiedType` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofSpecifiedType(type: DataTypeEnum, inputName: string, props: InputProps) ``` ###### `type`Required - *Type:* DataTypeEnum --- ###### `inputName`Required - *Type:* string --- ###### `props`Required - *Type:* InputProps --- ##### `ofTypeBoolean` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeBoolean(name: string, props?: BooleanInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* BooleanInputProps --- ##### `ofTypeInteger` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeInteger(name: string, props?: IntegerInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* IntegerInputProps --- ##### `ofTypeMapList` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeMapList(name: string, props?: MapListInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* MapListInputProps --- ##### `ofTypeString` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeString(name: string, props?: StringInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* StringInputProps --- ##### `ofTypeStringList` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeStringList(name: string, props?: StringListInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* StringListInputProps --- ##### `ofTypeStringMap` ```typescript import { Input } from '@cdklabs/cdk-ssm-documents' Input.ofTypeStringMap(name: string, props?: StringMapInputProps) ``` ###### `name`Required - *Type:* string --- ###### `props`Optional - *Type:* StringMapInputProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | inputType | DataTypeEnum | *No description.* | | name | string | *No description.* | | allowedPattern | string | *No description.* | | allowedValues | string[] | *No description.* | | defaultValue | string | *No description.* | | description | string | *No description.* | | maxChars | number | *No description.* | | maxItems | number | *No description.* | | minChars | number | *No description.* | | minItems | number | *No description.* | --- ##### `inputType`Required ```typescript public readonly inputType: DataTypeEnum; ``` - *Type:* DataTypeEnum --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `allowedPattern`Optional ```typescript public readonly allowedPattern: string; ``` - *Type:* string --- ##### `allowedValues`Optional ```typescript public readonly allowedValues: string[]; ``` - *Type:* string[] --- ##### `defaultValue`Optional ```typescript public readonly defaultValue: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `maxChars`Optional ```typescript public readonly maxChars: number; ``` - *Type:* number --- ##### `maxItems`Optional ```typescript public readonly maxItems: number; ``` - *Type:* number --- ##### `minChars`Optional ```typescript public readonly minChars: number; ``` - *Type:* number --- ##### `minItems`Optional ```typescript public readonly minItems: number; ``` - *Type:* number --- ### InstallationTypeVariable - *Implements:* IInstallationTypeVariable #### Initializers ```typescript import { InstallationTypeVariable } from '@cdklabs/cdk-ssm-documents' new InstallationTypeVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { InstallationTypeVariable } from '@cdklabs/cdk-ssm-documents' InstallationTypeVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### InstallUninstallRepairVariable - *Implements:* IInstallUninstallRepairVariable #### Initializers ```typescript import { InstallUninstallRepairVariable } from '@cdklabs/cdk-ssm-documents' new InstallUninstallRepairVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { InstallUninstallRepairVariable } from '@cdklabs/cdk-ssm-documents' InstallUninstallRepairVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### InvokeLambdaFunctionSimulation AutomationStep implemenation for aws:invokeLambdaFunction https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-lamb.html. #### Initializers ```typescript import { InvokeLambdaFunctionSimulation } from '@cdklabs/cdk-ssm-documents' new InvokeLambdaFunctionSimulation(step: InvokeLambdaFunctionStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | InvokeLambdaFunctionStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* InvokeLambdaFunctionStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### InvokeWebhookSimulation AutomationStep implementation for [aws:invokeWebhook](https://docs.aws.amazon.com/systems-manager/latest/userguide/invoke-webhook.html). #### Initializers ```typescript import { InvokeWebhookSimulation } from '@cdklabs/cdk-ssm-documents' new InvokeWebhookSimulation(step: InvokeWebhookStep, props: InvokeWebhookSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | InvokeWebhookStep | *No description.* | | props | InvokeWebhookSimulationProps | *No description.* | --- ##### `step`Required - *Type:* InvokeWebhookStep --- ##### `props`Required - *Type:* InvokeWebhookSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### LocalRunDocument - *Implements:* IRunDocumentLocation #### Initializers ```typescript import { LocalRunDocument } from '@cdklabs/cdk-ssm-documents' new LocalRunDocument(documentPath: IStringVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | documentPath | IStringVariable | *No description.* | --- ##### `documentPath`Required - *Type:* IStringVariable --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | IStringVariable | *No description.* | | type | string | *No description.* | --- ##### `location`Required ```typescript public readonly location: IStringVariable; ``` - *Type:* IStringVariable --- ##### `type`Required ```typescript public readonly type: string; ``` - *Type:* string --- ### LoggingEnvironment - *Implements:* IEnvironment Environment that simply logs the commands that it receives and displays them on the console. #### Initializers ```typescript import { LoggingEnvironment } from '@cdklabs/cdk-ssm-documents' new LoggingEnvironment() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | run | *No description.* | --- ##### `run` ```typescript public run(command: string): string ``` ###### `command`Required - *Type:* string --- ### MapListVariable - *Implements:* IMapListVariable A map list variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { MapListVariable } from '@cdklabs/cdk-ssm-documents' new MapListVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToMapList | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToMapList` ```typescript public resolveToMapList(inputs: {[ key: string ]: any}): {[ key: string ]: any}[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { MapListVariable } from '@cdklabs/cdk-ssm-documents' MapListVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### MockApprove - *Implements:* IApproveHook Mock implementation of IApproveHook. Does not simulate an approval request. #### Initializers ```typescript import { MockApprove } from '@cdklabs/cdk-ssm-documents' new MockApprove() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | ask | Ask for approval. | --- ##### `ask` ```typescript public ask(_approver: string): boolean ``` Ask for approval. ###### `_approver`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | timesInvoked | number | *No description.* | --- ##### `timesInvoked`Required ```typescript public readonly timesInvoked: number; ``` - *Type:* number --- ### MockAwsInvoker - *Implements:* IAwsInvoker Mock implementation of IAwsInvoker. This class can be reused for testing in exported JSII languages. #### Initializers ```typescript import { MockAwsInvoker } from '@cdklabs/cdk-ssm-documents' new MockAwsInvoker() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | invoke | Saves the invocation to be retrieved using getInvocations(). | | nextReturn | Set the next return value. | | whenThen | Allows developers to mock out responses from the AwsInvoker depending on the input that it receives. | --- ##### `invoke` ```typescript public invoke(invocation: Invocation): any ``` Saves the invocation to be retrieved using getInvocations(). ###### `invocation`Required - *Type:* Invocation --- ##### `nextReturn` ```typescript public nextReturn(awsResult: any): MockAwsInvoker ``` Set the next return value. This function can be chained to return subsequent return values. Values are read in order they were inserted. The last value is used as a default if there are no other values retrieved. In that way this function behaves the same way as Mockito .thenReturn(val). ###### `awsResult`Required - *Type:* any --- ##### `whenThen` ```typescript public whenThen(when: Invocation, then: {[ key: string ]: any}): void ``` Allows developers to mock out responses from the AwsInvoker depending on the input that it receives. ###### `when`Required - *Type:* Invocation defines the invocation to match and return the then. --- ###### `then`Required - *Type:* {[ key: string ]: any} is the value that should be returned if the above when Invocation is matched. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | previousInvocations | Invocation[] | All of the invocations that have been submitted to this invoker until present. | --- ##### `previousInvocations`Required ```typescript public readonly previousInvocations: Invocation[]; ``` - *Type:* Invocation[] All of the invocations that have been submitted to this invoker until present. --- ### MockEnvironment - *Implements:* IEnvironment Environment that simply saves commands into a previousCommands variable. This is useful if you want to unit test the commands that would be sent to a real environment. #### Initializers ```typescript import { MockEnvironment } from '@cdklabs/cdk-ssm-documents' new MockEnvironment() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | run | *No description.* | --- ##### `run` ```typescript public run(command: string): string ``` ###### `command`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | previousCommands | string[] | *No description.* | --- ##### `previousCommands`Required ```typescript public readonly previousCommands: string[]; ``` - *Type:* string[] --- ### MockPause - *Implements:* IPauseHook #### Initializers ```typescript import { MockPause } from '@cdklabs/cdk-ssm-documents' new MockPause() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | pause | *No description.* | --- ##### `pause` ```typescript public pause(): void ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | timesInvoked | number | *No description.* | --- ##### `timesInvoked`Required ```typescript public readonly timesInvoked: number; ``` - *Type:* number --- ### MockSleep - *Implements:* ISleepHook Mock ISleeper implementation. Simply logs that it is sleeping and returns immediately. #### Initializers ```typescript import { MockSleep } from '@cdklabs/cdk-ssm-documents' new MockSleep() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | sleep | *No description.* | --- ##### `sleep` ```typescript public sleep(timeMillis: number): void ``` ###### `timeMillis`Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sleepMilliInvocations | number[] | *No description.* | --- ##### `sleepMilliInvocations`Required ```typescript public readonly sleepMilliInvocations: number[]; ``` - *Type:* number[] --- ### NameDoc #### Initializers ```typescript import { NameDoc } from '@cdklabs/cdk-ssm-documents' new NameDoc(name: IStringVariable, version?: IStringVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | name | IStringVariable | *No description.* | | version | IStringVariable | *No description.* | --- ##### `name`Required - *Type:* IStringVariable --- ##### `version`Optional - *Type:* IStringVariable --- #### Methods | **Name** | **Description** | | --- | --- | | formatRequest | *No description.* | | requiredInputs | *No description.* | --- ##### `formatRequest` ```typescript public formatRequest(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | fromArn | *No description.* | | fromName | *No description.* | --- ##### `fromArn` ```typescript import { NameDoc } from '@cdklabs/cdk-ssm-documents' NameDoc.fromArn(arn: IStringVariable) ``` ###### `arn`Required - *Type:* IStringVariable --- ##### `fromName` ```typescript import { NameDoc } from '@cdklabs/cdk-ssm-documents' NameDoc.fromName(name: IStringVariable, version?: IStringVariable) ``` ###### `name`Required - *Type:* IStringVariable --- ###### `version`Optional - *Type:* IStringVariable --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | IStringVariable | *No description.* | | version | IStringVariable | *No description.* | --- ##### `name`Required ```typescript public readonly name: IStringVariable; ``` - *Type:* IStringVariable --- ##### `version`Optional ```typescript public readonly version: IStringVariable; ``` - *Type:* IStringVariable --- ### NoAuthMethod #### Initializers ```typescript import { NoAuthMethod } from '@cdklabs/cdk-ssm-documents' new NoAuthMethod() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | requiredInputs | *No description.* | | toEntry | *No description.* | --- ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` ##### `toEntry` ```typescript public toEntry(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | ofBasic | *No description.* | | ofDigest | *No description.* | | ofNone | *No description.* | --- ##### `ofBasic` ```typescript import { NoAuthMethod } from '@cdklabs/cdk-ssm-documents' NoAuthMethod.ofBasic(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofDigest` ```typescript import { NoAuthMethod } from '@cdklabs/cdk-ssm-documents' NoAuthMethod.ofDigest(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofNone` ```typescript import { NoAuthMethod } from '@cdklabs/cdk-ssm-documents' NoAuthMethod.ofNone() ``` ### NonSecureVariable A string variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { NonSecureVariable } from '@cdklabs/cdk-ssm-documents' new NonSecureVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Static Functions | **Name** | **Description** | | --- | --- | | ofParameter | *No description.* | | ofSecureToken | *No description.* | | ofValue | *No description.* | --- ##### `ofParameter` ```typescript import { NonSecureVariable } from '@cdklabs/cdk-ssm-documents' NonSecureVariable.ofParameter(reference: string) ``` ###### `reference`Required - *Type:* string --- ##### `ofSecureToken` ```typescript import { NonSecureVariable } from '@cdklabs/cdk-ssm-documents' NonSecureVariable.ofSecureToken(secureToken: string) ``` ###### `secureToken`Required - *Type:* string --- ##### `ofValue` ```typescript import { NonSecureVariable } from '@cdklabs/cdk-ssm-documents' NonSecureVariable.ofValue(value: string) ``` ###### `value`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### NoopObserver - *Implements:* IObserver #### Initializers ```typescript import { NoopObserver } from '@cdklabs/cdk-ssm-documents' new NoopObserver() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | accept | *No description.* | --- ##### `accept` ```typescript public accept(_value: {[ key: string ]: any}): void ``` ###### `_value`Required - *Type:* {[ key: string ]: any} --- ### NumberVariable - *Implements:* INumberVariable A number variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { NumberVariable } from '@cdklabs/cdk-ssm-documents' new NumberVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToNumber | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToNumber` ```typescript public resolveToNumber(inputs: {[ key: string ]: any}): number ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { NumberVariable } from '@cdklabs/cdk-ssm-documents' NumberVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### OnCancel Steps can specify an action to take onCancel. See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#canProp The supported actions are abort (default) or invoking a specific step. This behavior can be adopted by using the static methods available on OnCancel. #### Initializers ```typescript import { OnCancel } from '@cdklabs/cdk-ssm-documents' new OnCancel() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(currentStep: AutomationStep): string ``` ###### `currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a cancellation occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnCancel action. | --- ##### `abort` ```typescript import { OnCancel } from '@cdklabs/cdk-ssm-documents' OnCancel.abort() ``` To abort execution if a cancellation occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { OnCancel } from '@cdklabs/cdk-ssm-documents' OnCancel.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { OnCancel } from '@cdklabs/cdk-ssm-documents' OnCancel.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onCancel action. If you don't have a handle to the step object, use the invokeStepByName function. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { OnCancel } from '@cdklabs/cdk-ssm-documents' OnCancel.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnCancel action. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `stepName`Required - *Type:* string --- ### OnFailure Steps can specify an action to take onFailure. See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#failProp The supported actions are abort (default), continue, or invoking a specific step. This behavior can be adopted by using the static methods available on OnFailure. #### Initializers ```typescript import { OnFailure } from '@cdklabs/cdk-ssm-documents' new OnFailure() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(currentStep: AutomationStep): string ``` ###### `currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a failure occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnFailure action. | --- ##### `abort` ```typescript import { OnFailure } from '@cdklabs/cdk-ssm-documents' OnFailure.abort() ``` To abort execution if a failure occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { OnFailure } from '@cdklabs/cdk-ssm-documents' OnFailure.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { OnFailure } from '@cdklabs/cdk-ssm-documents' OnFailure.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onFailure action. If you don't have a handle to the step object, use the invokeStepByName function. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { OnFailure } from '@cdklabs/cdk-ssm-documents' OnFailure.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnFailure action. ###### `stepName`Required - *Type:* string --- ### OnFailureVariable - *Implements:* IOnFailureVariable #### Initializers ```typescript import { OnFailureVariable } from '@cdklabs/cdk-ssm-documents' new OnFailureVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { OnFailureVariable } from '@cdklabs/cdk-ssm-documents' OnFailureVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### OperationEvaluator #### Initializers ```typescript import { OperationEvaluator } from '@cdklabs/cdk-ssm-documents' new OperationEvaluator(operation: Operation) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | operation | Operation | *No description.* | --- ##### `operation`Required - *Type:* Operation --- #### Methods | **Name** | **Description** | | --- | --- | | evaluate | Evaluates this operation against the provided inputs. | | toOperationName | *No description.* | --- ##### `evaluate` ```typescript public evaluate(value1: any, value2: any): boolean ``` Evaluates this operation against the provided inputs. ###### `value1`Required - *Type:* any --- ###### `value2`Required - *Type:* any --- ##### `toOperationName` ```typescript public toOperationName(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | fromOperationName | Converts a string to OperationType. | --- ##### `fromOperationName` ```typescript import { OperationEvaluator } from '@cdklabs/cdk-ssm-documents' OperationEvaluator.fromOperationName(operationName: string) ``` Converts a string to OperationType. ###### `operationName`Required - *Type:* string an operation name to return its OperationType. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operation | Operation | *No description.* | --- ##### `operation`Required ```typescript public readonly operation: Operation; ``` - *Type:* Operation --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | STRING_TO_OPERATION | {[ key: string ]: Operation} | *No description.* | --- ##### `STRING_TO_OPERATION`Required ```typescript public readonly STRING_TO_OPERATION: {[ key: string ]: Operation}; ``` - *Type:* {[ key: string ]: Operation} --- ### PackageNameVariable - *Implements:* IPackageNameVariable #### Initializers ```typescript import { PackageNameVariable } from '@cdklabs/cdk-ssm-documents' new PackageNameVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { PackageNameVariable } from '@cdklabs/cdk-ssm-documents' PackageNameVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### PauseImpl - *Implements:* IPauseHook This IPauseHook implementation provides a real pause and wait for user input of Enter. This implementation does not work well on all exported JSII languages. Users can provide their own impl using the IPauseHook interface. #### Initializers ```typescript import { PauseImpl } from '@cdklabs/cdk-ssm-documents' new PauseImpl() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | pause | *No description.* | --- ##### `pause` ```typescript public pause(): void ``` ### PauseSimulation AutomationStep implementation for aws:pause https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-pause.html. #### Initializers ```typescript import { PauseSimulation } from '@cdklabs/cdk-ssm-documents' new PauseSimulation(step: PauseStep, props: PauseSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | PauseStep | *No description.* | | props | PauseSimulationProps | *No description.* | --- ##### `step`Required - *Type:* PauseStep --- ##### `props`Required - *Type:* PauseSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | May perform a real pause based on the params used during instance creation. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(_inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` May perform a real pause based on the params used during instance creation. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### Platforms #### Static Functions | **Name** | **Description** | | --- | --- | | toPlatform | Converts a string to Platform. | --- ##### `toPlatform` ```typescript import { Platforms } from '@cdklabs/cdk-ssm-documents' Platforms.toPlatform(platformString: string) ``` Converts a string to Platform. ###### `platformString`Required - *Type:* string a platform name to return its Platform type. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | STRING_TO_PLATFORM | {[ key: string ]: Platform} | *No description.* | --- ##### `STRING_TO_PLATFORM`Required ```typescript public readonly STRING_TO_PLATFORM: {[ key: string ]: Platform}; ``` - *Type:* {[ key: string ]: Platform} --- ### Precondition #### Methods | **Name** | **Description** | | --- | --- | | asSsmEntry | *No description.* | | evaluate | Evaluates if the precondition is met, by comparing the variable with the constant using the operator. | --- ##### `asSsmEntry` ```typescript public asSsmEntry(): {[ key: string ]: any} ``` ##### `evaluate` ```typescript public evaluate(inputs: {[ key: string ]: any}): boolean ``` Evaluates if the precondition is met, by comparing the variable with the constant using the operator. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | newPlatformPrecondition | Returns a new Precondition. | --- ##### `newPlatformPrecondition` ```typescript import { Precondition } from '@cdklabs/cdk-ssm-documents' Precondition.newPlatformPrecondition(platform: Platform) ``` Returns a new Precondition. ###### `platform`Required - *Type:* Platform The platform the preconditions tests against. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | operationType | Operation | *No description.* | | variable1 | IGenericVariable | *No description.* | | variable2 | IGenericVariable | *No description.* | --- ##### `operationType`Required ```typescript public readonly operationType: Operation; ``` - *Type:* Operation --- ##### `variable1`Required ```typescript public readonly variable1: IGenericVariable; ``` - *Type:* IGenericVariable --- ##### `variable2`Required ```typescript public readonly variable2: IGenericVariable; ``` - *Type:* IGenericVariable --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | INJECTED_PLAYFORM_TYPE_KEY | string | *No description.* | --- ##### `INJECTED_PLAYFORM_TYPE_KEY`Required ```typescript public readonly INJECTED_PLAYFORM_TYPE_KEY: string; ``` - *Type:* string --- ### PsModuleSimulation #### Initializers ```typescript import { PsModuleSimulation } from '@cdklabs/cdk-ssm-documents' new PsModuleSimulation(step: PsModuleStep, props: EnvironmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | PsModuleStep | *No description.* | | props | EnvironmentProps | *No description.* | --- ##### `step`Required - *Type:* PsModuleStep --- ##### `props`Required - *Type:* EnvironmentProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | Installs the module specified by source then runs the specified commands. | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): void ``` Installs the module specified by source then runs the specified commands. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ### ReflectiveAwsInvoker - *Implements:* IAwsInvoker Implementation of IAwsInvoker that executes the AWS api for real. If using this implementation, be sure that AWS credentials are available to the execution. #### Initializers ```typescript import { ReflectiveAwsInvoker } from '@cdklabs/cdk-ssm-documents' new ReflectiveAwsInvoker() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invoke AWS with the provided invocation request. | --- ##### `invoke` ```typescript public invoke(invocation: Invocation): any ``` Invoke AWS with the provided invocation request. ###### `invocation`Required - *Type:* Invocation --- ### ResourceTypeVariable - *Implements:* IResourceTypeVariable #### Initializers ```typescript import { ResourceTypeVariable } from '@cdklabs/cdk-ssm-documents' new ResourceTypeVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { ResourceTypeVariable } from '@cdklabs/cdk-ssm-documents' ResourceTypeVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | | validValues | string[] | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ##### `validValues`Required ```typescript public readonly validValues: string[]; ``` - *Type:* string[] --- ### RunCommandSimulation AutomationStep implementation of [aws:runCommand](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-runcommand.html). #### Initializers ```typescript import { RunCommandSimulation } from '@cdklabs/cdk-ssm-documents' new RunCommandSimulation(step: RunCommandStep, props: RunCommandSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | RunCommandStep | *No description.* | | props | RunCommandSimulationProps | *No description.* | --- ##### `step`Required - *Type:* RunCommandStep --- ##### `props`Required - *Type:* RunCommandSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | May perform a real approval ask based on the params used during instance creation. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` May perform a real approval ask based on the params used during instance creation. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### RunInstanceSimulation AutomationStep implemenation for aws:runInstance https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-runinstance.html. #### Initializers ```typescript import { RunInstanceSimulation } from '@cdklabs/cdk-ssm-documents' new RunInstanceSimulation(step: RunInstanceStep, props: AwsInvocationSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | RunInstanceStep | *No description.* | | props | AwsInvocationSimulationProps | *No description.* | --- ##### `step`Required - *Type:* RunInstanceStep --- ##### `props`Required - *Type:* AwsInvocationSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### RunPowerShellScriptSimulation #### Initializers ```typescript import { RunPowerShellScriptSimulation } from '@cdklabs/cdk-ssm-documents' new RunPowerShellScriptSimulation(step: RunPowerShellScriptStep, props: EnvironmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | RunPowerShellScriptStep | *No description.* | | props | EnvironmentProps | *No description.* | --- ##### `step`Required - *Type:* RunPowerShellScriptStep --- ##### `props`Required - *Type:* EnvironmentProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | Executes the runCommands against the environment provided in the constructor. | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): void ``` Executes the runCommands against the environment provided in the constructor. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ### RunShellScriptSimulation #### Initializers ```typescript import { RunShellScriptSimulation } from '@cdklabs/cdk-ssm-documents' new RunShellScriptSimulation(step: RunShellScriptStep, props: EnvironmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | RunShellScriptStep | *No description.* | | props | EnvironmentProps | *No description.* | --- ##### `step`Required - *Type:* RunShellScriptStep --- ##### `props`Required - *Type:* EnvironmentProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | Executes the runCommands against the environment provided in the constructor. | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): void ``` Executes the runCommands against the environment provided in the constructor. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ### S3Content - *Implements:* IDownloadableContent #### Initializers ```typescript import { S3Content } from '@cdklabs/cdk-ssm-documents' new S3Content(props: S3ContentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | S3ContentProps | *No description.* | --- ##### `props`Required - *Type:* S3ContentProps --- #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | IStringVariable | *No description.* | | sourceType | string | *No description.* | --- ##### `path`Required ```typescript public readonly path: IStringVariable; ``` - *Type:* IStringVariable --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ### ScriptCode The code to run for the execution. See "script" parameter here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html Attachments are not yet supported. #### Initializers ```typescript import { ScriptCode } from '@cdklabs/cdk-ssm-documents' new ScriptCode() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | codeAsString | *No description.* | | createOrGetFile | If there is a file for this code, return it. | --- ##### `codeAsString` ```typescript public codeAsString(): string ``` ##### `createOrGetFile` ```typescript public createOrGetFile(suffix: string): string ``` If there is a file for this code, return it. Otherwise, create a file with the specified suffix. ###### `suffix`Required - *Type:* string of the file to create (such as ".py"). --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromFile | Full path to the code to execute. | | inline | Inline code to be executed. | --- ##### `fromFile` ```typescript import { ScriptCode } from '@cdklabs/cdk-ssm-documents' ScriptCode.fromFile(fullPath: string) ``` Full path to the code to execute. File is parsed to produce yaml/json. Simulation will execute this file using the language specified. (Attachments not yet supported) ###### `fullPath`Required - *Type:* string --- ##### `inline` ```typescript import { ScriptCode } from '@cdklabs/cdk-ssm-documents' ScriptCode.inline(code: string) ``` Inline code to be executed. String will be used to produce function in yaml/json. Simulation will execute the function in this string using the language specified. ###### `code`Required - *Type:* string --- ### ScriptLanguage Specifies the script language as described in the "Runtime" argument here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html. #### Initializers ```typescript import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents' new ScriptLanguage() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | fileSuffix | The suffix to apply to file names of this type of execution. | | runtime | The associated runtime of this ScriptLanguage. | | simulate | Simulate an execution of this ScriptLanguage. | | ssmInputs | Builds the ssm inputs. | --- ##### `fileSuffix` ```typescript public fileSuffix(): string ``` The suffix to apply to file names of this type of execution. ##### `runtime` ```typescript public runtime(): string ``` The associated runtime of this ScriptLanguage. ##### `simulate` ```typescript public simulate(code: ScriptCode, inputs: {[ key: string ]: string}): {[ key: string ]: string} ``` Simulate an execution of this ScriptLanguage. Provide the inputs after replaced with the actual values (not variables). ###### `code`Required - *Type:* ScriptCode --- ###### `inputs`Required - *Type:* {[ key: string ]: string} --- ##### `ssmInputs` ```typescript public ssmInputs(): {[ key: string ]: string} ``` Builds the ssm inputs. #### Static Functions | **Name** | **Description** | | --- | --- | | fromRuntime | Creates a ScriptLanguage based on the provided runtime. | | python | Create a new ScriptLanguage for python execution. | --- ##### `fromRuntime` ```typescript import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents' ScriptLanguage.fromRuntime(runtime: string, handlerName?: string) ``` Creates a ScriptLanguage based on the provided runtime. Prefer one of the other static constructors if possible. ###### `runtime`Required - *Type:* string is the runtime name (such as "python3.6"). --- ###### `handlerName`Optional - *Type:* string to be provided for python executions. --- ##### `python` ```typescript import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents' ScriptLanguage.python(version: PythonVersion, handlerName: string) ``` Create a new ScriptLanguage for python execution. ###### `version`Required - *Type:* PythonVersion is the pythonVersion to use when writing the document (for simulation will not matter). --- ###### `handlerName`Required - *Type:* string is the function name in code as entry point for script handler. --- ### SecureVariable - *Implements:* IGenericVariable A secure string variable. Only supported by Command documents (only supported in downloadContent plugin). #### Initializers ```typescript import { SecureVariable } from '@cdklabs/cdk-ssm-documents' new SecureVariable() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Static Functions | **Name** | **Description** | | --- | --- | | ofParameter | *No description.* | | ofSecureToken | *No description.* | | ofValue | *No description.* | --- ##### `ofParameter` ```typescript import { SecureVariable } from '@cdklabs/cdk-ssm-documents' SecureVariable.ofParameter(reference: string) ``` ###### `reference`Required - *Type:* string --- ##### `ofSecureToken` ```typescript import { SecureVariable } from '@cdklabs/cdk-ssm-documents' SecureVariable.ofSecureToken(secureToken: string) ``` ###### `secureToken`Required - *Type:* string --- ##### `ofValue` ```typescript import { SecureVariable } from '@cdklabs/cdk-ssm-documents' SecureVariable.ofValue(value: string) ``` ###### `value`Required - *Type:* string --- ### Simulation #### Methods | **Name** | **Description** | | --- | --- | | simulate | Synthesize before calling this function! You can use this to Synthesize: SynthUtils.synthesize(stack); | --- ##### `simulate` ```typescript public simulate(inputs: {[ key: string ]: any}): DocumentResult ``` Synthesize before calling this function! You can use this to Synthesize: SynthUtils.synthesize(stack); Executes the SSM Document in simulation mode. This method DOES NOT result in invocation of SSM APIs. Rather, all steps are executed locally and mimic the behavior of SSM. If any inputs are not provided in this function, the specified defaults for the inputs will be used. ###### `inputs`Required - *Type:* {[ key: string ]: any} the inputs to feed into the simulated execution. --- #### Static Functions | **Name** | **Description** | | --- | --- | | ofAutomation | *No description.* | | ofCommand | *No description.* | --- ##### `ofAutomation` ```typescript import { Simulation } from '@cdklabs/cdk-ssm-documents' Simulation.ofAutomation(document: AutomationDocument, props: AutomationSimulationProps) ``` ###### `document`Required - *Type:* AutomationDocument --- ###### `props`Required - *Type:* AutomationSimulationProps --- ##### `ofCommand` ```typescript import { Simulation } from '@cdklabs/cdk-ssm-documents' Simulation.ofCommand(document: CommandDocument, props: CommandSimulationProps) ``` ###### `document`Required - *Type:* CommandDocument --- ###### `props`Required - *Type:* CommandSimulationProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | document | SsmDocument | *No description.* | | props | SimulationProps | *No description.* | --- ##### `document`Required ```typescript public readonly document: SsmDocument; ``` - *Type:* SsmDocument --- ##### `props`Required ```typescript public readonly props: SimulationProps; ``` - *Type:* SimulationProps --- ### SleepImpl - *Implements:* ISleepHook Performs a real sleep. #### Initializers ```typescript import { SleepImpl } from '@cdklabs/cdk-ssm-documents' new SleepImpl() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | sleep | Synchronously sleeps for duration specified in millis. | --- ##### `sleep` ```typescript public sleep(timeMillis: number): void ``` Synchronously sleeps for duration specified in millis. ###### `timeMillis`Required - *Type:* number --- ### SleepSimulation AutomationStep implemenation for aws:sleep https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-sleep.html. #### Initializers ```typescript import { SleepSimulation } from '@cdklabs/cdk-ssm-documents' new SleepSimulation(step: SleepStep, props: SleepSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | SleepStep | *No description.* | | props | SleepSimulationProps | *No description.* | --- ##### `step`Required - *Type:* SleepStep --- ##### `props`Required - *Type:* SleepSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | *No description.* | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(_inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### SSMDocumentContent - *Implements:* IDownloadableContent #### Initializers ```typescript import { SSMDocumentContent } from '@cdklabs/cdk-ssm-documents' new SSMDocumentContent(props: SsmDocumentContentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SsmDocumentContentProps | *No description.* | --- ##### `props`Required - *Type:* SsmDocumentContentProps --- #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentSource | DocumentSource | *No description.* | | sourceType | string | *No description.* | --- ##### `documentSource`Required ```typescript public readonly documentSource: DocumentSource; ``` - *Type:* DocumentSource --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ### SsmRunDocument - *Implements:* IRunDocumentLocation #### Initializers ```typescript import { SsmRunDocument } from '@cdklabs/cdk-ssm-documents' new SsmRunDocument(documentName: IStringVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | documentName | IStringVariable | *No description.* | --- ##### `documentName`Required - *Type:* IStringVariable --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | IStringVariable | *No description.* | | type | string | *No description.* | --- ##### `location`Required ```typescript public readonly location: IStringVariable; ``` - *Type:* IStringVariable --- ##### `type`Required ```typescript public readonly type: string; ``` - *Type:* string --- ### SsmSecureVariable #### Initializers ```typescript import { SsmSecureVariable } from '@cdklabs/cdk-ssm-documents' new SsmSecureVariable(secureToken: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | secureToken | string | *No description.* | --- ##### `secureToken`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(_inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Static Functions | **Name** | **Description** | | --- | --- | | ofParameter | *No description.* | | ofSecureToken | *No description.* | | ofValue | *No description.* | --- ##### `ofParameter` ```typescript import { SsmSecureVariable } from '@cdklabs/cdk-ssm-documents' SsmSecureVariable.ofParameter(reference: string) ``` ###### `reference`Required - *Type:* string --- ##### `ofSecureToken` ```typescript import { SsmSecureVariable } from '@cdklabs/cdk-ssm-documents' SsmSecureVariable.ofSecureToken(secureToken: string) ``` ###### `secureToken`Required - *Type:* string --- ##### `ofValue` ```typescript import { SsmSecureVariable } from '@cdklabs/cdk-ssm-documents' SsmSecureVariable.ofValue(value: string) ``` ###### `value`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secureToken | string | *No description.* | --- ##### `secureToken`Required ```typescript public readonly secureToken: string; ``` - *Type:* string --- ### StepFallback #### Initializers ```typescript import { StepFallback } from '@cdklabs/cdk-ssm-documents' new StepFallback(step: AutomationStep, validateStepAction: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AutomationStep | *No description.* | | validateStepAction | boolean | *No description.* | --- ##### `step`Required - *Type:* AutomationStep --- ##### `validateStepAction`Required - *Type:* boolean --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(_currentStep: AutomationStep): string ``` ###### `_currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a cancellation occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnCancel action. | --- ##### `abort` ```typescript import { StepFallback } from '@cdklabs/cdk-ssm-documents' StepFallback.abort() ``` To abort execution if a cancellation occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { StepFallback } from '@cdklabs/cdk-ssm-documents' StepFallback.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { StepFallback } from '@cdklabs/cdk-ssm-documents' StepFallback.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onCancel action. If you don't have a handle to the step object, use the invokeStepByName function. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { StepFallback } from '@cdklabs/cdk-ssm-documents' StepFallback.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnCancel action. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `stepName`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | step | AutomationStep | *No description.* | --- ##### `step`Required ```typescript public readonly step: AutomationStep; ``` - *Type:* AutomationStep --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ILLEGAL_FALLBACK_ACTIONS | string[] | *No description.* | --- ##### `ILLEGAL_FALLBACK_ACTIONS`Required ```typescript public readonly ILLEGAL_FALLBACK_ACTIONS: string[]; ``` - *Type:* string[] --- ### StepNameFallback #### Initializers ```typescript import { StepNameFallback } from '@cdklabs/cdk-ssm-documents' new StepNameFallback(step: string, validateStepAction: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | string | *No description.* | | validateStepAction | boolean | *No description.* | --- ##### `step`Required - *Type:* string --- ##### `validateStepAction`Required - *Type:* boolean --- #### Methods | **Name** | **Description** | | --- | --- | | stepToInvoke | *No description.* | | toSsmValue | *No description.* | --- ##### `stepToInvoke` ```typescript public stepToInvoke(currentStep: AutomationStep): string ``` ###### `currentStep`Required - *Type:* AutomationStep --- ##### `toSsmValue` ```typescript public toSsmValue(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | abort | To abort execution if a cancellation occurs during execution of the current step. | | continue | To continue execution of the subsequent step if a failure occurs during execution of the current step. | | invokeStep | Invoke a specific step. | | invokeStepByName | Invoke a specific step by the step name for the OnCancel action. | --- ##### `abort` ```typescript import { StepNameFallback } from '@cdklabs/cdk-ssm-documents' StepNameFallback.abort() ``` To abort execution if a cancellation occurs during execution of the current step. (This is the default behavior.) ##### `continue` ```typescript import { StepNameFallback } from '@cdklabs/cdk-ssm-documents' StepNameFallback.continue() ``` To continue execution of the subsequent step if a failure occurs during execution of the current step. ##### `invokeStep` ```typescript import { StepNameFallback } from '@cdklabs/cdk-ssm-documents' StepNameFallback.invokeStep(step: AutomationStep) ``` Invoke a specific step. Provide the step object to execute for the onCancel action. If you don't have a handle to the step object, use the invokeStepByName function. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `step`Required - *Type:* AutomationStep --- ##### `invokeStepByName` ```typescript import { StepNameFallback } from '@cdklabs/cdk-ssm-documents' StepNameFallback.invokeStepByName(stepName: string) ``` Invoke a specific step by the step name for the OnCancel action. Not all action types may be invoked during cancellation. See documentation referenced on this class. ###### `stepName`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | step | string | *No description.* | | validateStepAction | boolean | *No description.* | --- ##### `step`Required ```typescript public readonly step: string; ``` - *Type:* string --- ##### `validateStepAction`Required ```typescript public readonly validateStepAction: boolean; ``` - *Type:* boolean --- ### StepRef Class to reference AutomationSteps. The class allows steps to be referenced by the Step object or by the step name. #### Initializers ```typescript import { StepRef } from '@cdklabs/cdk-ssm-documents' new StepRef(stepName: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | stepName | string | *No description.* | --- ##### `stepName`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | resolve | Resolve to an AutomationStep object. | --- ##### `resolve` ```typescript public resolve(allStepsInExecution: AutomationStep[]): AutomationStep ``` Resolve to an AutomationStep object. Provide all the steps in the execution to find the associated step. ###### `allStepsInExecution`Required - *Type:* AutomationStep[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromName | Static constructor for creating a reference to a step from a step name. | | fromObject | Static constructor for creating a reference to a step from an AutomationStep object. | --- ##### `fromName` ```typescript import { StepRef } from '@cdklabs/cdk-ssm-documents' StepRef.fromName(stepName: string) ``` Static constructor for creating a reference to a step from a step name. ###### `stepName`Required - *Type:* string --- ##### `fromObject` ```typescript import { StepRef } from '@cdklabs/cdk-ssm-documents' StepRef.fromObject(step: AutomationStep) ``` Static constructor for creating a reference to a step from an AutomationStep object. ###### `step`Required - *Type:* AutomationStep --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stepName | string | *No description.* | --- ##### `stepName`Required ```typescript public readonly stepName: string; ``` - *Type:* string --- ### StringDocument This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File). Importing an existing file allows for benefiting from the simulated execution. The simulated execution will run locally in the same fashion that SSM Execution would run the document. You can supply mocks to the simulator and validate the calls and the flow of the document without running via SSM execution. #### Initializers ```typescript import { StringDocument } from '@cdklabs/cdk-ssm-documents' new StringDocument() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | fromFile | Create an AutomationDocument from an existing AutomationDocument yaml or json file. | | fromJson | Create an AutomationDocument from an existing json string. | | fromYaml | Create an AutomationDocument from an existing yaml string. | --- ##### `fromFile` ```typescript import { StringDocument } from '@cdklabs/cdk-ssm-documents' StringDocument.fromFile(stack: Construct, id: string, documentFilePath: string) ``` Create an AutomationDocument from an existing AutomationDocument yaml or json file. Note: This function will deduce whether the file is written in yaml or json based on whether it has a .yaml or .yml extention. You can use the returned AutomationDocument to run simulations as you would other documents created using this library. ###### `stack`Required - *Type:* constructs.Construct --- ###### `id`Required - *Type:* string --- ###### `documentFilePath`Required - *Type:* string --- ##### `fromJson` ```typescript import { StringDocument } from '@cdklabs/cdk-ssm-documents' StringDocument.fromJson(stack: Construct, id: string, documentJson: string) ``` Create an AutomationDocument from an existing json string. You can use the returned AutomationDocument to run simulations as you would other documents created using this library. ###### `stack`Required - *Type:* constructs.Construct --- ###### `id`Required - *Type:* string --- ###### `documentJson`Required - *Type:* string --- ##### `fromYaml` ```typescript import { StringDocument } from '@cdklabs/cdk-ssm-documents' StringDocument.fromYaml(stack: Construct, id: string, documentYaml: string) ``` Create an AutomationDocument from an existing yaml string. You can use the returned AutomationDocument to run simulations as you would other documents created using this library. ###### `stack`Required - *Type:* constructs.Construct --- ###### `id`Required - *Type:* string --- ###### `documentYaml`Required - *Type:* string --- ### StringFormat - *Implements:* IStringVariable Replacement for strings using Java String format style "%s" replacements. Example: new StringFormat("This %s a replacement: %s", [new HardCodedValue("is"), new ExportedVariable("myInput")]); The supported variable strings are either: 1. Implicit indices: "%s" where the first occurrence will match the first variable, the next will match the second... 2. Explicit indices: Example: "%1$s"; where "%1$s" matches the first variable and "%1$s" matches the second. Do not combine usage of implicit and explicit indices. Choose one per StringFormat instance. #### Initializers ```typescript import { StringFormat } from '@cdklabs/cdk-ssm-documents' new StringFormat(format: string, variables?: IGenericVariable[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | format | string | *No description.* | | variables | IGenericVariable[] | *No description.* | --- ##### `format`Required - *Type:* string --- ##### `variables`Optional - *Type:* IGenericVariable[] --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | format | string | *No description.* | | variables | IGenericVariable[] | *No description.* | --- ##### `format`Required ```typescript public readonly format: string; ``` - *Type:* string --- ##### `variables`Required ```typescript public readonly variables: IGenericVariable[]; ``` - *Type:* IGenericVariable[] --- ### StringListVariable - *Implements:* IStringListVariable A string list variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { StringListVariable } from '@cdklabs/cdk-ssm-documents' new StringListVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToStringList | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToStringList` ```typescript public resolveToStringList(inputs: {[ key: string ]: any}): string[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { StringListVariable } from '@cdklabs/cdk-ssm-documents' StringListVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### StringMapVariable - *Implements:* IStringMapVariable A string map variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { StringMapVariable } from '@cdklabs/cdk-ssm-documents' new StringMapVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToStringMap | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToStringMap` ```typescript public resolveToStringMap(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { StringMapVariable } from '@cdklabs/cdk-ssm-documents' StringMapVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### StringVariable - *Implements:* IStringVariable A string variable reference. Used to resolve the value from step inputs. #### Initializers ```typescript import { StringVariable } from '@cdklabs/cdk-ssm-documents' new StringVariable(reference: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | | toString | Returns a string representation of an object. | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { StringVariable } from '@cdklabs/cdk-ssm-documents' StringVariable.of(reference: string) ``` ###### `reference`Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | reference | string | *No description.* | --- ##### `reference`Required ```typescript public readonly reference: string; ``` - *Type:* string --- ### SynthUtils Wraps SynthUtils from @aws-cdk/assert because that package is not exported via JSII. #### Initializers ```typescript import { SynthUtils } from '@cdklabs/cdk-ssm-documents' new SynthUtils() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | synthesize | Wraps @aws-cdk/assert SynthUtils.synthesize(stack). Synthesizes the stack provided. | --- ##### `synthesize` ```typescript import { SynthUtils } from '@cdklabs/cdk-ssm-documents' SynthUtils.synthesize(stack: Stack) ``` Wraps @aws-cdk/assert SynthUtils.synthesize(stack). Synthesizes the stack provided. ###### `stack`Required - *Type:* aws-cdk-lib.Stack --- ### UsernamePasswordAuthMethod #### Initializers ```typescript import { UsernamePasswordAuthMethod } from '@cdklabs/cdk-ssm-documents' new UsernamePasswordAuthMethod(authMethod: string, userName: SecureVariable, password: SecureVariable) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | authMethod | string | *No description.* | | userName | SecureVariable | *No description.* | | password | SecureVariable | *No description.* | --- ##### `authMethod`Required - *Type:* string --- ##### `userName`Required - *Type:* SecureVariable --- ##### `password`Required - *Type:* SecureVariable --- #### Methods | **Name** | **Description** | | --- | --- | | requiredInputs | *No description.* | | toEntry | *No description.* | --- ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` ##### `toEntry` ```typescript public toEntry(): {[ key: string ]: any} ``` #### Static Functions | **Name** | **Description** | | --- | --- | | ofBasic | *No description.* | | ofDigest | *No description.* | | ofNone | *No description.* | --- ##### `ofBasic` ```typescript import { UsernamePasswordAuthMethod } from '@cdklabs/cdk-ssm-documents' UsernamePasswordAuthMethod.ofBasic(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofDigest` ```typescript import { UsernamePasswordAuthMethod } from '@cdklabs/cdk-ssm-documents' UsernamePasswordAuthMethod.ofDigest(userName: SecureVariable, password: SecureVariable) ``` ###### `userName`Required - *Type:* SecureVariable --- ###### `password`Required - *Type:* SecureVariable --- ##### `ofNone` ```typescript import { UsernamePasswordAuthMethod } from '@cdklabs/cdk-ssm-documents' UsernamePasswordAuthMethod.ofNone() ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authMethod | string | *No description.* | | password | SecureVariable | *No description.* | | userName | SecureVariable | *No description.* | --- ##### `authMethod`Required ```typescript public readonly authMethod: string; ``` - *Type:* string --- ##### `password`Required ```typescript public readonly password: SecureVariable; ``` - *Type:* SecureVariable --- ##### `userName`Required ```typescript public readonly userName: SecureVariable; ``` - *Type:* SecureVariable --- ### WaitForResourceSimulation AutomationStep impl for aws:waitForAwsResourceProperty https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-waitForAwsResourceProperty.html. #### Initializers ```typescript import { WaitForResourceSimulation } from '@cdklabs/cdk-ssm-documents' new WaitForResourceSimulation(step: WaitForResourceStep, props: WaitForResourceSimulationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | step | WaitForResourceStep | *No description.* | | props | WaitForResourceSimulationProps | *No description.* | --- ##### `step`Required - *Type:* WaitForResourceStep --- ##### `props`Required - *Type:* WaitForResourceSimulationProps --- #### Methods | **Name** | **Description** | | --- | --- | | executeStep | As is the case in an SSM Automation execution, this will continue to sleep/execute until desired value is found. | | nextStep | *No description.* | --- ##### `executeStep` ```typescript public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` As is the case in an SSM Automation execution, this will continue to sleep/execute until desired value is found. This function will throw if the timeoutSeconds is exceeded and the desired value is still not received from AWS. ###### `inputs`Required - *Type:* {[ key: string ]: any} --- ##### `nextStep` ```typescript public nextStep(_inputs: {[ key: string ]: any}): AutomationStep ``` ###### `_inputs`Required - *Type:* {[ key: string ]: any} --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | action | string | *No description.* | --- ##### `action`Required ```typescript public readonly action: string; ``` - *Type:* string --- ### WebhookImpl - *Implements:* IWebhook #### Initializers ```typescript import { WebhookImpl } from '@cdklabs/cdk-ssm-documents' new WebhookImpl() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invoke the web hook. | --- ##### `invoke` ```typescript public invoke(_props: InvokeWebhookProps): InvokeWebhookResult ``` Invoke the web hook. ###### `_props`Required - *Type:* InvokeWebhookProps --- ## Protocols ### IActionVariable - *Extends:* IStringVariable - *Implemented By:* ActionVariable, HardCodedAction, IActionVariable ### IApproveHook - *Implemented By:* ApproveImpl, MockApprove, IApproveHook This can be used to provide a hook for approval implementation for ApproveStep. #### Methods | **Name** | **Description** | | --- | --- | | ask | Ask for approval. | --- ##### `ask` ```typescript public ask(approver: string): boolean ``` Ask for approval. ###### `approver`Required - *Type:* string --- ### IAutomationComponent - *Implemented By:* ApproveStep, AssertAwsResourceStep, AutomationStep, AwsApiStep, BranchStep, ChangeInstanceStateStep, CompositeAutomationStep, CopyImageStep, CreateImageStep, CreateStackStep, CreateTagsStep, DeleteImageStep, DeleteStackStep, ExecuteAutomationStep, ExecuteScriptStep, ExecuteStateMachineStep, InvokeLambdaFunctionStep, InvokeWebhookStep, PauseStep, RebootInstanceAndWait, RunCommandStep, RunInstanceStep, SleepStep, StringStep, WaitForResourceStep, IAutomationComponent #### Methods | **Name** | **Description** | | --- | --- | | addToDocument | *No description.* | --- ##### `addToDocument` ```typescript public addToDocument(doc: AutomationDocumentBuilder): void ``` ###### `doc`Required - *Type:* AutomationDocumentBuilder --- ### IAwsInvoker - *Implemented By:* MockAwsInvoker, ReflectiveAwsInvoker, IAwsInvoker Aws invoker interface. This can be used to provide a hook for AWS invocation of steps so as to mock AWS behavior for simulation runs. #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invoke AWS with the provided invocation request. | --- ##### `invoke` ```typescript public invoke(invocation: Invocation): any ``` Invoke AWS with the provided invocation request. > [Invocation](Invocation) ###### `invocation`Required - *Type:* Invocation --- ### IBooleanVariable - *Extends:* IGenericVariable - *Implemented By:* BooleanVariable, HardCodedBoolean, IBooleanVariable A boolean variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToBoolean | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToBoolean` ```typescript public resolveToBoolean(inputs: {[ key: string ]: any}): boolean ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### ICommandComponent - *Implemented By:* ApplicationsStep, CommandStep, CompositeCommandStep, ConfigureDockerStep, ConfigurePackageStep, DomainJoinStep, DownloadContentStep, PsModuleStep, RunDockerActionStep, RunDocumentStep, RunPowerShellScriptStep, RunShellScriptStep, SoftwareInventoryStep, UpdateAgentStep, UpdateSSMAgentStep, ICommandComponent #### Methods | **Name** | **Description** | | --- | --- | | addToDocument | *No description.* | --- ##### `addToDocument` ```typescript public addToDocument(doc: CommandDocumentBuilder): void ``` ###### `doc`Required - *Type:* CommandDocumentBuilder --- ### IDesiredStateVariable - *Extends:* IStringVariable - *Implemented By:* DesiredStateVariable, HardCodedDesiredState, IDesiredStateVariable ### IDocumentHashTypeVariable - *Extends:* IStringVariable - *Implemented By:* DocumentHashTypeVariable, HardCodedDocumentHashType, IDocumentHashTypeVariable ### IDownloadableContent - *Implemented By:* GitContent, GitHubContent, HttpContent, S3Content, SSMDocumentContent, IDownloadableContent #### Methods | **Name** | **Description** | | --- | --- | | formatSourceInfo | *No description.* | | requiredInputs | *No description.* | --- ##### `formatSourceInfo` ```typescript public formatSourceInfo(): {[ key: string ]: any} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | sourceType | string | *No description.* | --- ##### `sourceType`Required ```typescript public readonly sourceType: string; ``` - *Type:* string --- ### IEnvironment - *Implemented By:* DockerEnvironment, LoggingEnvironment, MockEnvironment, IEnvironment IEnvironment is an abstraction for EC2 instances. The implementations of this interface provides customers with alternatives to test their commands rather than a real instance. #### Methods | **Name** | **Description** | | --- | --- | | run | *No description.* | --- ##### `run` ```typescript public run(command: string): string ``` ###### `command`Required - *Type:* string --- ### IExecuteAutomationHook - *Implemented By:* ApiExecuteAutomationHook, IExecuteAutomationHook Interface for simulating aws:executeAutomation. #### Methods | **Name** | **Description** | | --- | --- | | execute | Simulate the aws:executeAutomation. | --- ##### `execute` ```typescript public execute(props: ExecuteAutomationProps): ExecuteAutomationOutputs ``` Simulate the aws:executeAutomation. ###### `props`Required - *Type:* ExecuteAutomationProps --- ### IGenericVariable - *Implemented By:* ActionVariable, BooleanVariable, DesiredStateVariable, DictFormat, DocumentHashTypeVariable, GenericVariable, HardCodedAction, HardCodedBoolean, HardCodedDesiredState, HardCodedDocumentHashType, HardCodedInstallUninstallRepair, HardCodedInstallationType, HardCodedMapList, HardCodedNumber, HardCodedOnFailure, HardCodedPackageName, HardCodedResourceType, HardCodedSecureVariable, HardCodedString, HardCodedStringList, HardCodedStringMap, HardCodedValueBase, InstallUninstallRepairVariable, InstallationTypeVariable, MapListVariable, NonSecureVariable, NumberVariable, OnFailureVariable, PackageNameVariable, ResourceTypeVariable, SecureVariable, SsmSecureVariable, StringFormat, StringListVariable, StringMapVariable, StringVariable, IActionVariable, IBooleanVariable, IDesiredStateVariable, IDocumentHashTypeVariable, IGenericVariable, IInstallUninstallRepairVariable, IInstallationTypeVariable, IMapListVariable, INumberVariable, IOnFailureVariable, IPackageNameVariable, IResourceTypeVariable, IStringListVariable, IStringMapVariable, IStringVariable Variables hold references to a value. There are two implementations: HardCodedValue and ExportedVariable. This interface allows you to reference variable outputs from previous steps via the exported step.variable(). If you do not have a reference to a variable, you may generate your own variable using the ExportedVariable ctor. In the event that a hardcoded value is passed into a step, you can reference the value with a HardCodedValue. #### Methods | **Name** | **Description** | | --- | --- | | print | Prints the variable in a way that SSM understands. | | requiredInputs | The inputs that are required for determining the value of this variable. | | resolve | Given the execution inputs, return the resolved value of this variable. | | toJSON | JSON.stringify(variable) will implicitly invoke this variable. | --- ##### `print` ```typescript public print(): any ``` Prints the variable in a way that SSM understands. This is typically in the form of {{ Variable }} or the value. *Example* ```typescript {{ MyVariable }} ``` ##### `requiredInputs` ```typescript public requiredInputs(): string[] ``` The inputs that are required for determining the value of this variable. In the case of a single variable string, this will return a single value. ##### `resolve` ```typescript public resolve(inputs: {[ key: string ]: any}): any ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ##### `toJSON` ```typescript public toJSON(): any ``` JSON.stringify(variable) will implicitly invoke this variable. ### IInstallationTypeVariable - *Extends:* IStringVariable - *Implemented By:* HardCodedInstallationType, InstallationTypeVariable, IInstallationTypeVariable ### IInstallUninstallRepairVariable - *Extends:* IStringVariable - *Implemented By:* HardCodedInstallUninstallRepair, InstallUninstallRepairVariable, IInstallUninstallRepairVariable ### IMapListVariable - *Extends:* IGenericVariable - *Implemented By:* HardCodedMapList, MapListVariable, IMapListVariable A map list variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToMapList | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToMapList` ```typescript public resolveToMapList(inputs: {[ key: string ]: any}): {[ key: string ]: any}[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### INumberVariable - *Extends:* IGenericVariable - *Implemented By:* HardCodedNumber, NumberVariable, INumberVariable A number variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToNumber | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToNumber` ```typescript public resolveToNumber(inputs: {[ key: string ]: any}): number ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### IObserver - *Implemented By:* NoopObserver, IObserver #### Methods | **Name** | **Description** | | --- | --- | | accept | *No description.* | --- ##### `accept` ```typescript public accept(value: {[ key: string ]: any}): void ``` ###### `value`Required - *Type:* {[ key: string ]: any} --- ### IOnFailureVariable - *Extends:* IStringVariable - *Implemented By:* HardCodedOnFailure, OnFailureVariable, IOnFailureVariable ### IPackageNameVariable - *Extends:* IStringVariable - *Implemented By:* HardCodedPackageName, PackageNameVariable, IPackageNameVariable ### IParameterResolver - *Implemented By:* IParameterResolver Resolver for secure strings in Parameters. #### Methods | **Name** | **Description** | | --- | --- | | resolve | Resolve the token to its value. | --- ##### `resolve` ```typescript public resolve(input: string): string ``` Resolve the token to its value. ###### `input`Required - *Type:* string --- ### IPauseHook - *Implemented By:* MockPause, PauseImpl, IPauseHook This can be used to provide a hook for pausing implementation for PauseStep. #### Methods | **Name** | **Description** | | --- | --- | | pause | *No description.* | --- ##### `pause` ```typescript public pause(): void ``` ### IResourceTypeVariable - *Extends:* IStringVariable - *Implemented By:* HardCodedResourceType, ResourceTypeVariable, IResourceTypeVariable ### IRunCommandHook - *Implemented By:* ApiRunCommandHook, IRunCommandHook Interface for simulating aws:runCommand. #### Methods | **Name** | **Description** | | --- | --- | | execute | Simulate the aws:runCommand. | --- ##### `execute` ```typescript public execute(props: RunCommandProps): RunCommandOutputs ``` Simulate the aws:runCommand. ###### `props`Required - *Type:* RunCommandProps --- ### IRunDocumentLocation - *Implemented By:* LocalRunDocument, SsmRunDocument, IRunDocumentLocation #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | location | IStringVariable | *No description.* | | type | string | *No description.* | --- ##### `location`Required ```typescript public readonly location: IStringVariable; ``` - *Type:* IStringVariable --- ##### `type`Required ```typescript public readonly type: string; ``` - *Type:* string --- ### ISleepHook - *Implemented By:* MockSleep, SleepImpl, ISleepHook This can be used to provide a hook for sleeping for SleepStep (and other places where sleep is required). #### Methods | **Name** | **Description** | | --- | --- | | sleep | *No description.* | --- ##### `sleep` ```typescript public sleep(timeMillis: number): void ``` ###### `timeMillis`Required - *Type:* number --- ### IStringListVariable - *Extends:* IGenericVariable - *Implemented By:* HardCodedStringList, StringListVariable, IStringListVariable A string list variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToStringList | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToStringList` ```typescript public resolveToStringList(inputs: {[ key: string ]: any}): string[] ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### IStringMapVariable - *Extends:* IGenericVariable - *Implemented By:* HardCodedStringMap, StringMapVariable, IStringMapVariable A string map variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToStringMap | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToStringMap` ```typescript public resolveToStringMap(inputs: {[ key: string ]: any}): {[ key: string ]: any} ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### IStringVariable - *Extends:* IGenericVariable - *Implemented By:* ActionVariable, DesiredStateVariable, DictFormat, DocumentHashTypeVariable, HardCodedAction, HardCodedDesiredState, HardCodedDocumentHashType, HardCodedInstallUninstallRepair, HardCodedInstallationType, HardCodedOnFailure, HardCodedPackageName, HardCodedResourceType, HardCodedString, InstallUninstallRepairVariable, InstallationTypeVariable, OnFailureVariable, PackageNameVariable, ResourceTypeVariable, StringFormat, StringVariable, IActionVariable, IDesiredStateVariable, IDocumentHashTypeVariable, IInstallUninstallRepairVariable, IInstallationTypeVariable, IOnFailureVariable, IPackageNameVariable, IResourceTypeVariable, IStringVariable A string variable. #### Methods | **Name** | **Description** | | --- | --- | | resolveToString | Given the execution inputs, return the resolved value of this variable. | --- ##### `resolveToString` ```typescript public resolveToString(inputs: {[ key: string ]: any}): string ``` Given the execution inputs, return the resolved value of this variable. ###### `inputs`Required - *Type:* {[ key: string ]: any} are the execution inputs. --- ### IWebhook - *Implemented By:* WebhookImpl, IWebhook Hook for simulating aws:invokeWebhook. #### Methods | **Name** | **Description** | | --- | --- | | invoke | Invoke the web hook. | --- ##### `invoke` ```typescript public invoke(props: InvokeWebhookProps): InvokeWebhookResult ``` Invoke the web hook. ###### `props`Required - *Type:* InvokeWebhookProps --- ## Enums ### BodyOrUrlType #### Members | **Name** | **Description** | | --- | --- | | BODY | *No description.* | | URL | *No description.* | --- ##### `BODY` --- ##### `URL` --- ### DataTypeEnum DataTypes as supported by SSM Documents. #### Members | **Name** | **Description** | | --- | --- | | STRING | *No description.* | | INTEGER | *No description.* | | BOOLEAN | *No description.* | | STRING_LIST | *No description.* | | STRING_MAP | *No description.* | | MAP_LIST | *No description.* | --- ##### `STRING` --- ##### `INTEGER` --- ##### `BOOLEAN` --- ##### `STRING_LIST` --- ##### `STRING_MAP` --- ##### `MAP_LIST` --- ### DocumentFormat #### Members | **Name** | **Description** | | --- | --- | | JSON | *No description.* | | YAML | *No description.* | --- ##### `JSON` --- ##### `YAML` --- ### Operation Operation to use for comparing a Choice's or Preconditions with provided value. See https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-branch.html or https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html #### Members | **Name** | **Description** | | --- | --- | | BOOLEAN_EQUALS | *No description.* | | CONTAINS | *No description.* | | ENDS_WITH | *No description.* | | STARTS_WITH | *No description.* | | STRING_EQUALS | *No description.* | | EQUALS_IGNORE_CASE | *No description.* | | NUMERIC_EQUALS | *No description.* | | NUMERIC_GREATER | *No description.* | | NUMERIC_GREATER_OR_EQUALS | *No description.* | | NUMERIC_LESSER | *No description.* | | NUMERIC_LESSER_OR_EQUALS | *No description.* | --- ##### `BOOLEAN_EQUALS` --- ##### `CONTAINS` --- ##### `ENDS_WITH` --- ##### `STARTS_WITH` --- ##### `STRING_EQUALS` --- ##### `EQUALS_IGNORE_CASE` --- ##### `NUMERIC_EQUALS` --- ##### `NUMERIC_GREATER` --- ##### `NUMERIC_GREATER_OR_EQUALS` --- ##### `NUMERIC_LESSER` --- ##### `NUMERIC_LESSER_OR_EQUALS` --- ### Platform Command steps are not all applicable to all platforms. Each command step declares which Platforms it supports. That allows customers to validate their CommandDocument against a given platform prior to execution. #### Members | **Name** | **Description** | | --- | --- | | LINUX | *No description.* | | WINDOWS | *No description.* | | MAC_OS | *No description.* | --- ##### `LINUX` --- ##### `WINDOWS` --- ##### `MAC_OS` --- ### PythonVersion Python runtime to use when writing SSM Document. Simulation will use local python version. #### Members | **Name** | **Description** | | --- | --- | | VERSION_3_6 | *No description.* | | VERSION_3_7 | *No description.* | | VERSION_3_8 | *No description.* | --- ##### `VERSION_3_6` --- ##### `VERSION_3_7` --- ##### `VERSION_3_8` --- ### ResponseCode Steps report their ResponseCode using this enum. A successful response will contain the outputs expected. A failed/canceled response will contain the stackTrace. #### Members | **Name** | **Description** | | --- | --- | | SUCCESS | *No description.* | | CANCELED | *No description.* | | FAILED | *No description.* | --- ##### `SUCCESS` --- ##### `CANCELED` --- ##### `FAILED` ---