@cdklabs/cdk-ssm-documents 0.0.24 → 0.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +996 -7
- package/API.md +768 -92
- package/README.md +25 -3
- package/changelog.md +3 -3
- package/lib/construct/synth-utils.js +1 -1
- package/lib/document/automation-document.js +1 -1
- package/lib/document/command-document.js +1 -1
- package/lib/document/document-builder.js +2 -2
- package/lib/document/ssm-document.js +1 -1
- package/lib/domain/choice.js +1 -1
- package/lib/domain/data-type.js +1 -1
- package/lib/domain/enum/install-action.js +2 -2
- package/lib/domain/enum/install-uninstall-repair.js +2 -2
- package/lib/domain/enum/installation-type.js +2 -2
- package/lib/domain/enum/package-name.js +2 -2
- package/lib/domain/input.js +1 -1
- package/lib/domain/operation.js +1 -1
- package/lib/domain/platform.js +1 -1
- package/lib/domain/precondition.js +1 -1
- package/lib/incident-response/incident-response.d.ts +138 -0
- package/lib/incident-response/incident-response.js +114 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/lib/interface/approve-hook.js +2 -2
- package/lib/interface/auth-method.js +3 -3
- package/lib/interface/aws-invoker.js +2 -2
- package/lib/interface/downloadable-content.js +8 -8
- package/lib/interface/environment.js +3 -3
- package/lib/interface/execute-automation-hook/api-execute-automation-hook.js +1 -1
- package/lib/interface/observer.js +1 -1
- package/lib/interface/on-failure.js +6 -6
- package/lib/interface/pause-hook.js +2 -2
- package/lib/interface/run-command-hook/api-run-command-hook.js +1 -1
- package/lib/interface/run-document-location.js +2 -2
- package/lib/interface/sleep-hook.js +2 -2
- package/lib/interface/step-ref.js +1 -1
- package/lib/interface/variables/boolean-variable.js +2 -2
- package/lib/interface/variables/map-list-variable.js +2 -2
- package/lib/interface/variables/number-variable.js +2 -2
- package/lib/interface/variables/secure-string-variable.js +4 -4
- package/lib/interface/variables/string-list-variable.js +2 -2
- package/lib/interface/variables/string-map-variable.js +2 -2
- package/lib/interface/variables/string-variable.js +4 -4
- package/lib/interface/variables/variable.js +2 -2
- package/lib/interface/webhook.js +1 -1
- package/lib/parent-steps/automation/approve-step.js +1 -1
- package/lib/parent-steps/automation/assert-aws-resource-step.js +1 -1
- package/lib/parent-steps/automation/aws-api-step.js +1 -1
- package/lib/parent-steps/automation/branch-step.js +1 -1
- package/lib/parent-steps/automation/change-instance-state-step.js +3 -3
- package/lib/parent-steps/automation/copy-image-step.js +1 -1
- package/lib/parent-steps/automation/create-image-step.js +1 -1
- package/lib/parent-steps/automation/create-stack-step.js +3 -3
- package/lib/parent-steps/automation/create-tags-step.js +3 -3
- package/lib/parent-steps/automation/delete-image-step.js +1 -1
- package/lib/parent-steps/automation/delete-stack-step.js +1 -1
- package/lib/parent-steps/automation/execute-automation-step.js +1 -1
- package/lib/parent-steps/automation/execute-script-step.js +5 -5
- package/lib/parent-steps/automation/execute-state-machine-step.js +1 -1
- package/lib/parent-steps/automation/invoke-lambda-function-step.js +1 -1
- package/lib/parent-steps/automation/invoke-webhook-step.js +1 -1
- package/lib/parent-steps/automation/pause-step.js +1 -1
- package/lib/parent-steps/automation/run-command-step.js +3 -3
- package/lib/parent-steps/automation/run-instance-step.js +1 -1
- package/lib/parent-steps/automation/sleep-step.js +1 -1
- package/lib/parent-steps/automation/wait-for-resource-step.js +1 -1
- package/lib/parent-steps/automation-step.js +1 -1
- package/lib/parent-steps/command/applications-step.js +1 -1
- package/lib/parent-steps/command/configure-docker-step.js +1 -1
- package/lib/parent-steps/command/configure-package-step.js +1 -1
- package/lib/parent-steps/command/domain-join-step.js +1 -1
- package/lib/parent-steps/command/download-content-step.js +1 -1
- package/lib/parent-steps/command/ps-module-step.js +1 -1
- package/lib/parent-steps/command/run-docker-action-step.js +1 -1
- package/lib/parent-steps/command/run-document-step.js +1 -1
- package/lib/parent-steps/command/run-powershell-script-step.js +1 -1
- package/lib/parent-steps/command/run-shell-script-step.js +1 -1
- package/lib/parent-steps/command/software-inventory-step.js +1 -1
- package/lib/parent-steps/command/update-agent-step.js +1 -1
- package/lib/parent-steps/command/update-ssm-agent-step.js +1 -1
- package/lib/parent-steps/command-step.js +1 -1
- package/lib/parent-steps/step.js +1 -1
- package/lib/patterns/automation/composite-step.js +2 -2
- package/lib/patterns/automation/reboot-instance-and-wait.js +1 -1
- package/lib/patterns/automation/string-step.js +1 -1
- package/lib/patterns/document/string-document.js +1 -1
- package/lib/patterns/document/timed-document.js +1 -1
- package/lib/samples/hello-world.js +1 -1
- package/lib/simulation/automation/approve-simulation.js +1 -1
- package/lib/simulation/automation/assert-aws-resource-simulation.js +1 -1
- package/lib/simulation/automation/automation-simulation-base.js +1 -1
- package/lib/simulation/automation/aws-api-simulation.js +1 -1
- package/lib/simulation/automation/branch-simulation.js +1 -1
- package/lib/simulation/automation/change-instance-state-simulation.js +1 -1
- package/lib/simulation/automation/copy-image-simulation.js +1 -1
- package/lib/simulation/automation/create-image-simulation.js +1 -1
- package/lib/simulation/automation/create-stack-simulation.js +1 -1
- package/lib/simulation/automation/create-tags-simulation.js +1 -1
- package/lib/simulation/automation/delete-image-simulation.js +1 -1
- package/lib/simulation/automation/delete-stack-simulation.js +1 -1
- package/lib/simulation/automation/execute-script-simulation.js +1 -1
- package/lib/simulation/automation/execute-state-machine-simulation.js +1 -1
- package/lib/simulation/automation/invoke-lambda-function-simulation.js +1 -1
- package/lib/simulation/automation/invoke-webhook-simulation.js +1 -1
- package/lib/simulation/automation/pause-simulation.js +1 -1
- package/lib/simulation/automation/run-command-simulation.js +1 -1
- package/lib/simulation/automation/run-instance-simulation.js +1 -1
- package/lib/simulation/automation/sleep-simulation.js +1 -1
- package/lib/simulation/automation/wait-for-resource-simulation.js +1 -1
- package/lib/simulation/automation-step-simulation.js +1 -1
- package/lib/simulation/command/command-simulation-base.js +1 -1
- package/lib/simulation/command/ps-module-simulation.js +1 -1
- package/lib/simulation/command/run-powershell-script-simulation.js +1 -1
- package/lib/simulation/command/run-shell-script-simulation.js +1 -1
- package/lib/simulation/command-step-simulation.js +1 -1
- package/lib/simulation/document/automation-simulation.js +1 -1
- package/lib/simulation/document/command-simulation.js +1 -1
- package/lib/simulation/simulation.js +1 -1
- package/package.json +3 -3
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/node_modules/buffer/node_modules/ieee754/LICENSE +0 -11
- package/node_modules/buffer/node_modules/ieee754/README.md +0 -51
- package/node_modules/buffer/node_modules/ieee754/index.d.ts +0 -10
- package/node_modules/buffer/node_modules/ieee754/index.js +0 -85
- package/node_modules/buffer/node_modules/ieee754/package.json +0 -52
- package/node_modules/xml2js/node_modules/sax/LICENSE +0 -41
- package/node_modules/xml2js/node_modules/sax/README.md +0 -225
- package/node_modules/xml2js/node_modules/sax/lib/sax.js +0 -1565
- package/node_modules/xml2js/node_modules/sax/package.json +0 -25
package/API.md
CHANGED
|
@@ -8248,6 +8248,7 @@ new HelloWorld(app: Construct, id: string)
|
|
|
8248
8248
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.exportValue">exportValue</a></code> | Create a CloudFormation Export for a value. |
|
|
8249
8249
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.formatArn">formatArn</a></code> | Creates an ARN from components. |
|
|
8250
8250
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.getLogicalId">getLogicalId</a></code> | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. |
|
|
8251
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.regionalFact">regionalFact</a></code> | Look up a fact value for the given fact for the region of this stack. |
|
|
8251
8252
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.renameLogicalId">renameLogicalId</a></code> | Rename a generated logical identities. |
|
|
8252
8253
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.reportMissingContextKey">reportMissingContextKey</a></code> | Indicate that a context key was expected. |
|
|
8253
8254
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.resolve">resolve</a></code> | Resolve a tokenized value in the context of the current stack. |
|
|
@@ -8431,6 +8432,42 @@ The CloudFormation element for which a logical identity is needed.
|
|
|
8431
8432
|
|
|
8432
8433
|
---
|
|
8433
8434
|
|
|
8435
|
+
##### `regionalFact` <a name="regionalFact" id="@cdklabs/cdk-ssm-documents.HelloWorld.regionalFact"></a>
|
|
8436
|
+
|
|
8437
|
+
```typescript
|
|
8438
|
+
public regionalFact(factName: string, defaultValue?: string): string
|
|
8439
|
+
```
|
|
8440
|
+
|
|
8441
|
+
Look up a fact value for the given fact for the region of this stack.
|
|
8442
|
+
|
|
8443
|
+
Will return a definite value only if the region of the current stack is resolved.
|
|
8444
|
+
If not, a lookup map will be added to the stack and the lookup will be done at
|
|
8445
|
+
CDK deployment time.
|
|
8446
|
+
|
|
8447
|
+
What regions will be included in the lookup map is controlled by the
|
|
8448
|
+
`@aws-cdk/core:target-partitions` context value: it must be set to a list
|
|
8449
|
+
of partitions, and only regions from the given partitions will be included.
|
|
8450
|
+
If no such context key is set, all regions will be included.
|
|
8451
|
+
|
|
8452
|
+
This function is intended to be used by construct library authors. Application
|
|
8453
|
+
builders can rely on the abstractions offered by construct libraries and do
|
|
8454
|
+
not have to worry about regional facts.
|
|
8455
|
+
|
|
8456
|
+
If `defaultValue` is not given, it is an error if the fact is unknown for
|
|
8457
|
+
the given region.
|
|
8458
|
+
|
|
8459
|
+
###### `factName`<sup>Required</sup> <a name="factName" id="@cdklabs/cdk-ssm-documents.HelloWorld.regionalFact.parameter.factName"></a>
|
|
8460
|
+
|
|
8461
|
+
- *Type:* string
|
|
8462
|
+
|
|
8463
|
+
---
|
|
8464
|
+
|
|
8465
|
+
###### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.HelloWorld.regionalFact.parameter.defaultValue"></a>
|
|
8466
|
+
|
|
8467
|
+
- *Type:* string
|
|
8468
|
+
|
|
8469
|
+
---
|
|
8470
|
+
|
|
8434
8471
|
##### `renameLogicalId` <a name="renameLogicalId" id="@cdklabs/cdk-ssm-documents.HelloWorld.renameLogicalId"></a>
|
|
8435
8472
|
|
|
8436
8473
|
```typescript
|
|
@@ -8610,11 +8647,10 @@ The construct to start the search from.
|
|
|
8610
8647
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.account">account</a></code> | <code>string</code> | The AWS account into which this stack will be deployed. |
|
|
8611
8648
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.artifactId">artifactId</a></code> | <code>string</code> | The ID of the cloud assembly artifact for this stack. |
|
|
8612
8649
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.availabilityZones">availabilityZones</a></code> | <code>string[]</code> | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. |
|
|
8650
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.bundlingRequired">bundlingRequired</a></code> | <code>boolean</code> | Indicates whether the stack requires bundling or not. |
|
|
8613
8651
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.dependencies">dependencies</a></code> | <code>aws-cdk-lib.Stack[]</code> | Return the stacks this stack depends on. |
|
|
8614
8652
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.environment">environment</a></code> | <code>string</code> | The environment coordinates in which this stack is deployed. |
|
|
8615
8653
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.nested">nested</a></code> | <code>boolean</code> | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. |
|
|
8616
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackParent">nestedStackParent</a></code> | <code>aws-cdk-lib.Stack</code> | If this is a nested stack, returns it's parent stack. |
|
|
8617
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackResource">nestedStackResource</a></code> | <code>aws-cdk-lib.CfnResource</code> | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. |
|
|
8618
8654
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.notificationArns">notificationArns</a></code> | <code>string[]</code> | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. |
|
|
8619
8655
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.partition">partition</a></code> | <code>string</code> | The partition in which this stack is defined. |
|
|
8620
8656
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.region">region</a></code> | <code>string</code> | The AWS region into which this stack will be deployed (e.g. `us-west-2`). |
|
|
@@ -8624,8 +8660,10 @@ The construct to start the search from.
|
|
|
8624
8660
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.tags">tags</a></code> | <code>aws-cdk-lib.TagManager</code> | Tags to be applied to the stack. |
|
|
8625
8661
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.templateFile">templateFile</a></code> | <code>string</code> | The name of the CloudFormation template file emitted to the output directory during synthesis. |
|
|
8626
8662
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.templateOptions">templateOptions</a></code> | <code>aws-cdk-lib.ITemplateOptions</code> | Options for CloudFormation template (like version, transform, description). |
|
|
8627
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether termination protection is enabled for this stack. |
|
|
8628
8663
|
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.urlSuffix">urlSuffix</a></code> | <code>string</code> | The Amazon domain suffix for the region in which this stack is defined. |
|
|
8664
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackParent">nestedStackParent</a></code> | <code>aws-cdk-lib.Stack</code> | If this is a nested stack, returns it's parent stack. |
|
|
8665
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackResource">nestedStackResource</a></code> | <code>aws-cdk-lib.CfnResource</code> | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. |
|
|
8666
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.HelloWorld.property.terminationProtection">terminationProtection</a></code> | <code>boolean</code> | Whether termination protection is enabled for this stack. |
|
|
8629
8667
|
|
|
8630
8668
|
---
|
|
8631
8669
|
|
|
@@ -8705,6 +8743,18 @@ To specify a different strategy for selecting availability zones override this m
|
|
|
8705
8743
|
|
|
8706
8744
|
---
|
|
8707
8745
|
|
|
8746
|
+
##### `bundlingRequired`<sup>Required</sup> <a name="bundlingRequired" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.bundlingRequired"></a>
|
|
8747
|
+
|
|
8748
|
+
```typescript
|
|
8749
|
+
public readonly bundlingRequired: boolean;
|
|
8750
|
+
```
|
|
8751
|
+
|
|
8752
|
+
- *Type:* boolean
|
|
8753
|
+
|
|
8754
|
+
Indicates whether the stack requires bundling or not.
|
|
8755
|
+
|
|
8756
|
+
---
|
|
8757
|
+
|
|
8708
8758
|
##### `dependencies`<sup>Required</sup> <a name="dependencies" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.dependencies"></a>
|
|
8709
8759
|
|
|
8710
8760
|
```typescript
|
|
@@ -8753,32 +8803,6 @@ Indicates if this is a nested stack, in which case `parentStack` will include a
|
|
|
8753
8803
|
|
|
8754
8804
|
---
|
|
8755
8805
|
|
|
8756
|
-
##### `nestedStackParent`<sup>Optional</sup> <a name="nestedStackParent" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackParent"></a>
|
|
8757
|
-
|
|
8758
|
-
```typescript
|
|
8759
|
-
public readonly nestedStackParent: Stack;
|
|
8760
|
-
```
|
|
8761
|
-
|
|
8762
|
-
- *Type:* aws-cdk-lib.Stack
|
|
8763
|
-
|
|
8764
|
-
If this is a nested stack, returns it's parent stack.
|
|
8765
|
-
|
|
8766
|
-
---
|
|
8767
|
-
|
|
8768
|
-
##### `nestedStackResource`<sup>Optional</sup> <a name="nestedStackResource" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackResource"></a>
|
|
8769
|
-
|
|
8770
|
-
```typescript
|
|
8771
|
-
public readonly nestedStackResource: CfnResource;
|
|
8772
|
-
```
|
|
8773
|
-
|
|
8774
|
-
- *Type:* aws-cdk-lib.CfnResource
|
|
8775
|
-
|
|
8776
|
-
If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
|
|
8777
|
-
|
|
8778
|
-
`undefined` for top-level (non-nested) stacks.
|
|
8779
|
-
|
|
8780
|
-
---
|
|
8781
|
-
|
|
8782
8806
|
##### `notificationArns`<sup>Required</sup> <a name="notificationArns" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.notificationArns"></a>
|
|
8783
8807
|
|
|
8784
8808
|
```typescript
|
|
@@ -8923,6 +8947,44 @@ Options for CloudFormation template (like version, transform, description).
|
|
|
8923
8947
|
|
|
8924
8948
|
---
|
|
8925
8949
|
|
|
8950
|
+
##### `urlSuffix`<sup>Required</sup> <a name="urlSuffix" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.urlSuffix"></a>
|
|
8951
|
+
|
|
8952
|
+
```typescript
|
|
8953
|
+
public readonly urlSuffix: string;
|
|
8954
|
+
```
|
|
8955
|
+
|
|
8956
|
+
- *Type:* string
|
|
8957
|
+
|
|
8958
|
+
The Amazon domain suffix for the region in which this stack is defined.
|
|
8959
|
+
|
|
8960
|
+
---
|
|
8961
|
+
|
|
8962
|
+
##### `nestedStackParent`<sup>Optional</sup> <a name="nestedStackParent" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackParent"></a>
|
|
8963
|
+
|
|
8964
|
+
```typescript
|
|
8965
|
+
public readonly nestedStackParent: Stack;
|
|
8966
|
+
```
|
|
8967
|
+
|
|
8968
|
+
- *Type:* aws-cdk-lib.Stack
|
|
8969
|
+
|
|
8970
|
+
If this is a nested stack, returns it's parent stack.
|
|
8971
|
+
|
|
8972
|
+
---
|
|
8973
|
+
|
|
8974
|
+
##### `nestedStackResource`<sup>Optional</sup> <a name="nestedStackResource" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.nestedStackResource"></a>
|
|
8975
|
+
|
|
8976
|
+
```typescript
|
|
8977
|
+
public readonly nestedStackResource: CfnResource;
|
|
8978
|
+
```
|
|
8979
|
+
|
|
8980
|
+
- *Type:* aws-cdk-lib.CfnResource
|
|
8981
|
+
|
|
8982
|
+
If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
|
|
8983
|
+
|
|
8984
|
+
`undefined` for top-level (non-nested) stacks.
|
|
8985
|
+
|
|
8986
|
+
---
|
|
8987
|
+
|
|
8926
8988
|
##### `terminationProtection`<sup>Optional</sup> <a name="terminationProtection" id="@cdklabs/cdk-ssm-documents.HelloWorld.property.terminationProtection"></a>
|
|
8927
8989
|
|
|
8928
8990
|
```typescript
|
|
@@ -8935,15 +8997,115 @@ Whether termination protection is enabled for this stack.
|
|
|
8935
8997
|
|
|
8936
8998
|
---
|
|
8937
8999
|
|
|
8938
|
-
|
|
9000
|
+
|
|
9001
|
+
### IncidentResponse <a name="IncidentResponse" id="@cdklabs/cdk-ssm-documents.IncidentResponse"></a>
|
|
9002
|
+
|
|
9003
|
+
Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#aws-resource-ssmincidents-responseplan-properties.
|
|
9004
|
+
|
|
9005
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer"></a>
|
|
8939
9006
|
|
|
8940
9007
|
```typescript
|
|
8941
|
-
|
|
9008
|
+
import { IncidentResponse } from '@cdklabs/cdk-ssm-documents'
|
|
9009
|
+
|
|
9010
|
+
new IncidentResponse(scope: Construct, id: string, props: IncidentResponseProps)
|
|
8942
9011
|
```
|
|
8943
9012
|
|
|
9013
|
+
| **Name** | **Type** | **Description** |
|
|
9014
|
+
| --- | --- | --- |
|
|
9015
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
9016
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
9017
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps">IncidentResponseProps</a></code> | *No description.* |
|
|
9018
|
+
|
|
9019
|
+
---
|
|
9020
|
+
|
|
9021
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.scope"></a>
|
|
9022
|
+
|
|
9023
|
+
- *Type:* constructs.Construct
|
|
9024
|
+
|
|
9025
|
+
---
|
|
9026
|
+
|
|
9027
|
+
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.id"></a>
|
|
9028
|
+
|
|
8944
9029
|
- *Type:* string
|
|
8945
9030
|
|
|
8946
|
-
|
|
9031
|
+
---
|
|
9032
|
+
|
|
9033
|
+
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentResponse.Initializer.parameter.props"></a>
|
|
9034
|
+
|
|
9035
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps">IncidentResponseProps</a>
|
|
9036
|
+
|
|
9037
|
+
---
|
|
9038
|
+
|
|
9039
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
9040
|
+
|
|
9041
|
+
| **Name** | **Description** |
|
|
9042
|
+
| --- | --- |
|
|
9043
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
9044
|
+
|
|
9045
|
+
---
|
|
9046
|
+
|
|
9047
|
+
##### `toString` <a name="toString" id="@cdklabs/cdk-ssm-documents.IncidentResponse.toString"></a>
|
|
9048
|
+
|
|
9049
|
+
```typescript
|
|
9050
|
+
public toString(): string
|
|
9051
|
+
```
|
|
9052
|
+
|
|
9053
|
+
Returns a string representation of this construct.
|
|
9054
|
+
|
|
9055
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
9056
|
+
|
|
9057
|
+
| **Name** | **Description** |
|
|
9058
|
+
| --- | --- |
|
|
9059
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
9060
|
+
|
|
9061
|
+
---
|
|
9062
|
+
|
|
9063
|
+
##### ~~`isConstruct`~~ <a name="isConstruct" id="@cdklabs/cdk-ssm-documents.IncidentResponse.isConstruct"></a>
|
|
9064
|
+
|
|
9065
|
+
```typescript
|
|
9066
|
+
import { IncidentResponse } from '@cdklabs/cdk-ssm-documents'
|
|
9067
|
+
|
|
9068
|
+
IncidentResponse.isConstruct(x: any)
|
|
9069
|
+
```
|
|
9070
|
+
|
|
9071
|
+
Checks if `x` is a construct.
|
|
9072
|
+
|
|
9073
|
+
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-ssm-documents.IncidentResponse.isConstruct.parameter.x"></a>
|
|
9074
|
+
|
|
9075
|
+
- *Type:* any
|
|
9076
|
+
|
|
9077
|
+
Any object.
|
|
9078
|
+
|
|
9079
|
+
---
|
|
9080
|
+
|
|
9081
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
9082
|
+
|
|
9083
|
+
| **Name** | **Type** | **Description** |
|
|
9084
|
+
| --- | --- | --- |
|
|
9085
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
9086
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponse.property.cfnResponsePlan">cfnResponsePlan</a></code> | <code>aws-cdk-lib.aws_ssmincidents.CfnResponsePlan</code> | *No description.* |
|
|
9087
|
+
|
|
9088
|
+
---
|
|
9089
|
+
|
|
9090
|
+
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-ssm-documents.IncidentResponse.property.node"></a>
|
|
9091
|
+
|
|
9092
|
+
```typescript
|
|
9093
|
+
public readonly node: Node;
|
|
9094
|
+
```
|
|
9095
|
+
|
|
9096
|
+
- *Type:* constructs.Node
|
|
9097
|
+
|
|
9098
|
+
The tree node.
|
|
9099
|
+
|
|
9100
|
+
---
|
|
9101
|
+
|
|
9102
|
+
##### `cfnResponsePlan`<sup>Required</sup> <a name="cfnResponsePlan" id="@cdklabs/cdk-ssm-documents.IncidentResponse.property.cfnResponsePlan"></a>
|
|
9103
|
+
|
|
9104
|
+
```typescript
|
|
9105
|
+
public readonly cfnResponsePlan: CfnResponsePlan;
|
|
9106
|
+
```
|
|
9107
|
+
|
|
9108
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan
|
|
8947
9109
|
|
|
8948
9110
|
---
|
|
8949
9111
|
|
|
@@ -22385,148 +22547,336 @@ To use the Digest method, SSM Agent version 3.0.1181.0 or later must be installe
|
|
|
22385
22547
|
|
|
22386
22548
|
---
|
|
22387
22549
|
|
|
22388
|
-
###
|
|
22389
|
-
|
|
22390
|
-
Properties of inputs supported by SSM documents.
|
|
22550
|
+
### IncidentResponseProps <a name="IncidentResponseProps" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps"></a>
|
|
22391
22551
|
|
|
22392
|
-
|
|
22393
|
-
See https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-doc-syntax.html
|
|
22552
|
+
Provides props IncidentResponse.
|
|
22394
22553
|
|
|
22395
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.
|
|
22554
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.Initializer"></a>
|
|
22396
22555
|
|
|
22397
22556
|
```typescript
|
|
22398
|
-
import {
|
|
22557
|
+
import { IncidentResponseProps } from '@cdklabs/cdk-ssm-documents'
|
|
22399
22558
|
|
|
22400
|
-
const
|
|
22559
|
+
const incidentResponseProps: IncidentResponseProps = { ... }
|
|
22401
22560
|
```
|
|
22402
22561
|
|
|
22403
22562
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
22404
22563
|
|
|
22405
22564
|
| **Name** | **Type** | **Description** |
|
|
22406
22565
|
| --- | --- | --- |
|
|
22407
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22408
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22409
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22410
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22411
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22412
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22413
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxChars">maxChars</a></code> | <code>number</code> | (Optional) Maximum number of chars that this input value (string) must contain. |
|
|
22414
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
22415
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minChars">minChars</a></code> | <code>number</code> | (Optional) Minimum number of chars that this input value (string) must contain. |
|
|
22416
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
22566
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.actions">actions</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction">IncidentResponseAction</a>[]</code> | The actions that the response plan starts at the beginning of an incident. |
|
|
22567
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.incidentTemplate">incidentTemplate</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate">IncidentTemplate</a></code> | Details used to create an incident when using this response plan. |
|
|
22568
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.chatChannel">chatChannel</a></code> | <code>aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ChatChannelProperty \| aws-cdk-lib.IResolvable</code> | The AWS Chatbot chat channel used for collaboration during an incident. |
|
|
22569
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.displayName">displayName</a></code> | <code>string</code> | The human readable name of the response plan. |
|
|
22570
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.engagements">engagements</a></code> | <code>string[]</code> | The contacts and escalation plans that the response plan engages during an incident. |
|
|
22571
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.tags">tags</a></code> | <code>aws-cdk-lib.CfnTag[]</code> | An array of key-value pairs to apply to this resource. |
|
|
22417
22572
|
|
|
22418
22573
|
---
|
|
22419
22574
|
|
|
22420
|
-
##### `
|
|
22575
|
+
##### `actions`<sup>Required</sup> <a name="actions" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.actions"></a>
|
|
22421
22576
|
|
|
22422
22577
|
```typescript
|
|
22423
|
-
public readonly
|
|
22578
|
+
public readonly actions: IncidentResponseAction[];
|
|
22424
22579
|
```
|
|
22425
22580
|
|
|
22426
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
22581
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction">IncidentResponseAction</a>[]
|
|
22427
22582
|
|
|
22428
|
-
|
|
22583
|
+
The actions that the response plan starts at the beginning of an incident.
|
|
22429
22584
|
|
|
22430
22585
|
---
|
|
22431
22586
|
|
|
22432
|
-
##### `
|
|
22587
|
+
##### `incidentTemplate`<sup>Required</sup> <a name="incidentTemplate" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.incidentTemplate"></a>
|
|
22433
22588
|
|
|
22434
22589
|
```typescript
|
|
22435
|
-
public readonly
|
|
22590
|
+
public readonly incidentTemplate: IncidentTemplate;
|
|
22436
22591
|
```
|
|
22437
22592
|
|
|
22438
|
-
- *Type:*
|
|
22593
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate">IncidentTemplate</a>
|
|
22439
22594
|
|
|
22440
|
-
|
|
22595
|
+
Details used to create an incident when using this response plan.
|
|
22441
22596
|
|
|
22442
22597
|
---
|
|
22443
22598
|
|
|
22444
|
-
##### `
|
|
22599
|
+
##### `chatChannel`<sup>Optional</sup> <a name="chatChannel" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.chatChannel"></a>
|
|
22445
22600
|
|
|
22446
22601
|
```typescript
|
|
22447
|
-
public readonly
|
|
22602
|
+
public readonly chatChannel: ChatChannelProperty | IResolvable;
|
|
22448
22603
|
```
|
|
22449
22604
|
|
|
22450
|
-
- *Type:*
|
|
22451
|
-
- *Default:* undefined
|
|
22605
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ChatChannelProperty | aws-cdk-lib.IResolvable
|
|
22452
22606
|
|
|
22453
|
-
|
|
22607
|
+
The AWS Chatbot chat channel used for collaboration during an incident.
|
|
22608
|
+
|
|
22609
|
+
> [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)
|
|
22454
22610
|
|
|
22455
22611
|
---
|
|
22456
22612
|
|
|
22457
|
-
##### `
|
|
22613
|
+
##### `displayName`<sup>Optional</sup> <a name="displayName" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.displayName"></a>
|
|
22458
22614
|
|
|
22459
22615
|
```typescript
|
|
22460
|
-
public readonly
|
|
22616
|
+
public readonly displayName: string;
|
|
22461
22617
|
```
|
|
22462
22618
|
|
|
22463
|
-
- *Type:*
|
|
22464
|
-
- *Default:* undefined
|
|
22619
|
+
- *Type:* string
|
|
22465
22620
|
|
|
22466
|
-
|
|
22621
|
+
The human readable name of the response plan.
|
|
22622
|
+
|
|
22623
|
+
> [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)
|
|
22467
22624
|
|
|
22468
22625
|
---
|
|
22469
22626
|
|
|
22470
|
-
##### `
|
|
22627
|
+
##### `engagements`<sup>Optional</sup> <a name="engagements" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.engagements"></a>
|
|
22471
22628
|
|
|
22472
22629
|
```typescript
|
|
22473
|
-
public readonly
|
|
22630
|
+
public readonly engagements: string[];
|
|
22474
22631
|
```
|
|
22475
22632
|
|
|
22476
|
-
- *Type:*
|
|
22477
|
-
- *Default:* undefined
|
|
22633
|
+
- *Type:* string[]
|
|
22478
22634
|
|
|
22479
|
-
|
|
22635
|
+
The contacts and escalation plans that the response plan engages during an incident.
|
|
22636
|
+
|
|
22637
|
+
> [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)
|
|
22480
22638
|
|
|
22481
22639
|
---
|
|
22482
22640
|
|
|
22483
|
-
##### `
|
|
22641
|
+
##### `tags`<sup>Optional</sup> <a name="tags" id="@cdklabs/cdk-ssm-documents.IncidentResponseProps.property.tags"></a>
|
|
22484
22642
|
|
|
22485
22643
|
```typescript
|
|
22486
|
-
public readonly
|
|
22644
|
+
public readonly tags: CfnTag[];
|
|
22487
22645
|
```
|
|
22488
22646
|
|
|
22489
|
-
- *Type:*
|
|
22490
|
-
- *Default:* name
|
|
22647
|
+
- *Type:* aws-cdk-lib.CfnTag[]
|
|
22491
22648
|
|
|
22492
|
-
|
|
22649
|
+
An array of key-value pairs to apply to this resource.
|
|
22650
|
+
|
|
22651
|
+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
|
|
22652
|
+
|
|
22653
|
+
> [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)
|
|
22493
22654
|
|
|
22494
22655
|
---
|
|
22495
22656
|
|
|
22496
|
-
|
|
22657
|
+
### IncidentTemplateProps <a name="IncidentTemplateProps" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps"></a>
|
|
22658
|
+
|
|
22659
|
+
Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html.
|
|
22660
|
+
|
|
22661
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps.Initializer"></a>
|
|
22497
22662
|
|
|
22498
22663
|
```typescript
|
|
22499
|
-
|
|
22664
|
+
import { IncidentTemplateProps } from '@cdklabs/cdk-ssm-documents'
|
|
22665
|
+
|
|
22666
|
+
const incidentTemplateProps: IncidentTemplateProps = { ... }
|
|
22500
22667
|
```
|
|
22501
22668
|
|
|
22502
|
-
|
|
22503
|
-
- *Default:* undefined
|
|
22669
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
22504
22670
|
|
|
22505
|
-
|
|
22671
|
+
| **Name** | **Type** | **Description** |
|
|
22672
|
+
| --- | --- | --- |
|
|
22673
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.dedupeString">dedupeString</a></code> | <code>string</code> | Used to create only one incident record for an incident. |
|
|
22674
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.incidentTags">incidentTags</a></code> | <code>aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.CfnTag[]</code> | `CfnResponsePlan.IncidentTemplateProperty.IncidentTags`. |
|
|
22675
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.notificationTargets">notificationTargets</a></code> | <code>aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.NotificationTargetItemProperty \| aws-cdk-lib.IResolvable[]</code> | The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. |
|
|
22676
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.summary">summary</a></code> | <code>string</code> | The summary describes what has happened during the incident. |
|
|
22506
22677
|
|
|
22507
22678
|
---
|
|
22508
22679
|
|
|
22509
|
-
##### `
|
|
22680
|
+
##### `dedupeString`<sup>Optional</sup> <a name="dedupeString" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.dedupeString"></a>
|
|
22510
22681
|
|
|
22511
22682
|
```typescript
|
|
22512
|
-
public readonly
|
|
22683
|
+
public readonly dedupeString: string;
|
|
22513
22684
|
```
|
|
22514
22685
|
|
|
22515
|
-
- *Type:*
|
|
22516
|
-
- *Default:* undefined
|
|
22686
|
+
- *Type:* string
|
|
22517
22687
|
|
|
22518
|
-
|
|
22688
|
+
Used to create only one incident record for an incident.
|
|
22689
|
+
|
|
22690
|
+
> [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)
|
|
22519
22691
|
|
|
22520
22692
|
---
|
|
22521
22693
|
|
|
22522
|
-
##### `
|
|
22694
|
+
##### `incidentTags`<sup>Optional</sup> <a name="incidentTags" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.incidentTags"></a>
|
|
22523
22695
|
|
|
22524
22696
|
```typescript
|
|
22525
|
-
public readonly
|
|
22697
|
+
public readonly incidentTags: IResolvable | IResolvable | CfnTag[];
|
|
22526
22698
|
```
|
|
22527
22699
|
|
|
22528
|
-
- *Type:*
|
|
22529
|
-
|
|
22700
|
+
- *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.CfnTag[]
|
|
22701
|
+
|
|
22702
|
+
`CfnResponsePlan.IncidentTemplateProperty.IncidentTags`.
|
|
22703
|
+
|
|
22704
|
+
> [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)
|
|
22705
|
+
|
|
22706
|
+
---
|
|
22707
|
+
|
|
22708
|
+
##### `notificationTargets`<sup>Optional</sup> <a name="notificationTargets" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.notificationTargets"></a>
|
|
22709
|
+
|
|
22710
|
+
```typescript
|
|
22711
|
+
public readonly notificationTargets: IResolvable | NotificationTargetItemProperty | IResolvable[];
|
|
22712
|
+
```
|
|
22713
|
+
|
|
22714
|
+
- *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.NotificationTargetItemProperty | aws-cdk-lib.IResolvable[]
|
|
22715
|
+
|
|
22716
|
+
The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident.
|
|
22717
|
+
|
|
22718
|
+
You can also make updates to the incident through the chat channel using the SNS topics.
|
|
22719
|
+
|
|
22720
|
+
> [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)
|
|
22721
|
+
|
|
22722
|
+
---
|
|
22723
|
+
|
|
22724
|
+
##### `summary`<sup>Optional</sup> <a name="summary" id="@cdklabs/cdk-ssm-documents.IncidentTemplateProps.property.summary"></a>
|
|
22725
|
+
|
|
22726
|
+
```typescript
|
|
22727
|
+
public readonly summary: string;
|
|
22728
|
+
```
|
|
22729
|
+
|
|
22730
|
+
- *Type:* string
|
|
22731
|
+
|
|
22732
|
+
The summary describes what has happened during the incident.
|
|
22733
|
+
|
|
22734
|
+
> [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)
|
|
22735
|
+
|
|
22736
|
+
---
|
|
22737
|
+
|
|
22738
|
+
### InputProps <a name="InputProps" id="@cdklabs/cdk-ssm-documents.InputProps"></a>
|
|
22739
|
+
|
|
22740
|
+
Properties of inputs supported by SSM documents.
|
|
22741
|
+
|
|
22742
|
+
These are NOT used for declaring step inputs, rather only for document inputs.
|
|
22743
|
+
See https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-doc-syntax.html
|
|
22744
|
+
|
|
22745
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.InputProps.Initializer"></a>
|
|
22746
|
+
|
|
22747
|
+
```typescript
|
|
22748
|
+
import { InputProps } from '@cdklabs/cdk-ssm-documents'
|
|
22749
|
+
|
|
22750
|
+
const inputProps: InputProps = { ... }
|
|
22751
|
+
```
|
|
22752
|
+
|
|
22753
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
22754
|
+
|
|
22755
|
+
| **Name** | **Type** | **Description** |
|
|
22756
|
+
| --- | --- | --- |
|
|
22757
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.inputType">inputType</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a></code> | (Required) The DataTypeEnum of the input. |
|
|
22758
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.name">name</a></code> | <code>string</code> | (Required) The name of the input by which to be referenced by steps in the document. |
|
|
22759
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.allowedPattern">allowedPattern</a></code> | <code>string</code> | (Optional) Pattern that this input value must match. |
|
|
22760
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.allowedValues">allowedValues</a></code> | <code>any[]</code> | (Optional) List of allowed values that this input may be. |
|
|
22761
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.defaultValue">defaultValue</a></code> | <code>any</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
22762
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
22763
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxChars">maxChars</a></code> | <code>number</code> | (Optional) Maximum number of chars that this input value (string) must contain. |
|
|
22764
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
22765
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minChars">minChars</a></code> | <code>number</code> | (Optional) Minimum number of chars that this input value (string) must contain. |
|
|
22766
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
22767
|
+
|
|
22768
|
+
---
|
|
22769
|
+
|
|
22770
|
+
##### `inputType`<sup>Required</sup> <a name="inputType" id="@cdklabs/cdk-ssm-documents.InputProps.property.inputType"></a>
|
|
22771
|
+
|
|
22772
|
+
```typescript
|
|
22773
|
+
public readonly inputType: DataTypeEnum;
|
|
22774
|
+
```
|
|
22775
|
+
|
|
22776
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a>
|
|
22777
|
+
|
|
22778
|
+
(Required) The DataTypeEnum of the input.
|
|
22779
|
+
|
|
22780
|
+
---
|
|
22781
|
+
|
|
22782
|
+
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.InputProps.property.name"></a>
|
|
22783
|
+
|
|
22784
|
+
```typescript
|
|
22785
|
+
public readonly name: string;
|
|
22786
|
+
```
|
|
22787
|
+
|
|
22788
|
+
- *Type:* string
|
|
22789
|
+
|
|
22790
|
+
(Required) The name of the input by which to be referenced by steps in the document.
|
|
22791
|
+
|
|
22792
|
+
---
|
|
22793
|
+
|
|
22794
|
+
##### `allowedPattern`<sup>Optional</sup> <a name="allowedPattern" id="@cdklabs/cdk-ssm-documents.InputProps.property.allowedPattern"></a>
|
|
22795
|
+
|
|
22796
|
+
```typescript
|
|
22797
|
+
public readonly allowedPattern: string;
|
|
22798
|
+
```
|
|
22799
|
+
|
|
22800
|
+
- *Type:* string
|
|
22801
|
+
- *Default:* undefined
|
|
22802
|
+
|
|
22803
|
+
(Optional) Pattern that this input value must match.
|
|
22804
|
+
|
|
22805
|
+
---
|
|
22806
|
+
|
|
22807
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.InputProps.property.allowedValues"></a>
|
|
22808
|
+
|
|
22809
|
+
```typescript
|
|
22810
|
+
public readonly allowedValues: any[];
|
|
22811
|
+
```
|
|
22812
|
+
|
|
22813
|
+
- *Type:* any[]
|
|
22814
|
+
- *Default:* undefined
|
|
22815
|
+
|
|
22816
|
+
(Optional) List of allowed values that this input may be.
|
|
22817
|
+
|
|
22818
|
+
---
|
|
22819
|
+
|
|
22820
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.InputProps.property.defaultValue"></a>
|
|
22821
|
+
|
|
22822
|
+
```typescript
|
|
22823
|
+
public readonly defaultValue: any;
|
|
22824
|
+
```
|
|
22825
|
+
|
|
22826
|
+
- *Type:* any
|
|
22827
|
+
- *Default:* undefined
|
|
22828
|
+
|
|
22829
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
22830
|
+
|
|
22831
|
+
---
|
|
22832
|
+
|
|
22833
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.InputProps.property.description"></a>
|
|
22834
|
+
|
|
22835
|
+
```typescript
|
|
22836
|
+
public readonly description: string;
|
|
22837
|
+
```
|
|
22838
|
+
|
|
22839
|
+
- *Type:* string
|
|
22840
|
+
- *Default:* name
|
|
22841
|
+
|
|
22842
|
+
(Optional) The description of the input.
|
|
22843
|
+
|
|
22844
|
+
---
|
|
22845
|
+
|
|
22846
|
+
##### `maxChars`<sup>Optional</sup> <a name="maxChars" id="@cdklabs/cdk-ssm-documents.InputProps.property.maxChars"></a>
|
|
22847
|
+
|
|
22848
|
+
```typescript
|
|
22849
|
+
public readonly maxChars: number;
|
|
22850
|
+
```
|
|
22851
|
+
|
|
22852
|
+
- *Type:* number
|
|
22853
|
+
- *Default:* undefined
|
|
22854
|
+
|
|
22855
|
+
(Optional) Maximum number of chars that this input value (string) must contain.
|
|
22856
|
+
|
|
22857
|
+
---
|
|
22858
|
+
|
|
22859
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.InputProps.property.maxItems"></a>
|
|
22860
|
+
|
|
22861
|
+
```typescript
|
|
22862
|
+
public readonly maxItems: number;
|
|
22863
|
+
```
|
|
22864
|
+
|
|
22865
|
+
- *Type:* number
|
|
22866
|
+
- *Default:* undefined
|
|
22867
|
+
|
|
22868
|
+
(Optional) Maximum number of items that this input value (list) must contain.
|
|
22869
|
+
|
|
22870
|
+
---
|
|
22871
|
+
|
|
22872
|
+
##### `minChars`<sup>Optional</sup> <a name="minChars" id="@cdklabs/cdk-ssm-documents.InputProps.property.minChars"></a>
|
|
22873
|
+
|
|
22874
|
+
```typescript
|
|
22875
|
+
public readonly minChars: number;
|
|
22876
|
+
```
|
|
22877
|
+
|
|
22878
|
+
- *Type:* number
|
|
22879
|
+
- *Default:* undefined
|
|
22530
22880
|
|
|
22531
22881
|
(Optional) Minimum number of chars that this input value (string) must contain.
|
|
22532
22882
|
|
|
@@ -26675,6 +27025,55 @@ public readonly windowsUpdates: IStringVariable;
|
|
|
26675
27025
|
|
|
26676
27026
|
---
|
|
26677
27027
|
|
|
27028
|
+
### SsmAutomationProps <a name="SsmAutomationProps" id="@cdklabs/cdk-ssm-documents.SsmAutomationProps"></a>
|
|
27029
|
+
|
|
27030
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.SsmAutomationProps.Initializer"></a>
|
|
27031
|
+
|
|
27032
|
+
```typescript
|
|
27033
|
+
import { SsmAutomationProps } from '@cdklabs/cdk-ssm-documents'
|
|
27034
|
+
|
|
27035
|
+
const ssmAutomationProps: SsmAutomationProps = { ... }
|
|
27036
|
+
```
|
|
27037
|
+
|
|
27038
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
27039
|
+
|
|
27040
|
+
| **Name** | **Type** | **Description** |
|
|
27041
|
+
| --- | --- | --- |
|
|
27042
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmAutomationProps.property.parameters">parameters</a></code> | <code>{[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}</code> | Specify either StringVariables or HardCodedValues. |
|
|
27043
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmAutomationProps.property.targetAccount">targetAccount</a></code> | <code>string</code> | The account that the automation document will be run in. |
|
|
27044
|
+
|
|
27045
|
+
---
|
|
27046
|
+
|
|
27047
|
+
##### `parameters`<sup>Required</sup> <a name="parameters" id="@cdklabs/cdk-ssm-documents.SsmAutomationProps.property.parameters"></a>
|
|
27048
|
+
|
|
27049
|
+
```typescript
|
|
27050
|
+
public readonly parameters: {[ key: string ]: IGenericVariable};
|
|
27051
|
+
```
|
|
27052
|
+
|
|
27053
|
+
- *Type:* {[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}
|
|
27054
|
+
|
|
27055
|
+
Specify either StringVariables or HardCodedValues.
|
|
27056
|
+
|
|
27057
|
+
> [: 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)
|
|
27058
|
+
|
|
27059
|
+
---
|
|
27060
|
+
|
|
27061
|
+
##### `targetAccount`<sup>Optional</sup> <a name="targetAccount" id="@cdklabs/cdk-ssm-documents.SsmAutomationProps.property.targetAccount"></a>
|
|
27062
|
+
|
|
27063
|
+
```typescript
|
|
27064
|
+
public readonly targetAccount: string;
|
|
27065
|
+
```
|
|
27066
|
+
|
|
27067
|
+
- *Type:* string
|
|
27068
|
+
|
|
27069
|
+
The account that the automation document will be run in.
|
|
27070
|
+
|
|
27071
|
+
This can be in either the management account or an application account.
|
|
27072
|
+
|
|
27073
|
+
> [: 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)
|
|
27074
|
+
|
|
27075
|
+
---
|
|
27076
|
+
|
|
26678
27077
|
### SsmDocumentContentProps <a name="SsmDocumentContentProps" id="@cdklabs/cdk-ssm-documents.SsmDocumentContentProps"></a>
|
|
26679
27078
|
|
|
26680
27079
|
Properties.json for sourceType SsmDocument.
|
|
@@ -34532,6 +34931,283 @@ public readonly authMethod: AuthMethod;
|
|
|
34532
34931
|
---
|
|
34533
34932
|
|
|
34534
34933
|
|
|
34934
|
+
### IncidentResponseAction <a name="IncidentResponseAction" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction"></a>
|
|
34935
|
+
|
|
34936
|
+
The Action property type specifies the configuration to launch.
|
|
34937
|
+
|
|
34938
|
+
> [: 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)
|
|
34939
|
+
|
|
34940
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.Initializer"></a>
|
|
34941
|
+
|
|
34942
|
+
```typescript
|
|
34943
|
+
import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents'
|
|
34944
|
+
|
|
34945
|
+
new IncidentResponseAction(cfnEntry: ActionProperty)
|
|
34946
|
+
```
|
|
34947
|
+
|
|
34948
|
+
| **Name** | **Type** | **Description** |
|
|
34949
|
+
| --- | --- | --- |
|
|
34950
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction.Initializer.parameter.cfnEntry">cfnEntry</a></code> | <code>aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty</code> | *No description.* |
|
|
34951
|
+
|
|
34952
|
+
---
|
|
34953
|
+
|
|
34954
|
+
##### `cfnEntry`<sup>Required</sup> <a name="cfnEntry" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.Initializer.parameter.cfnEntry"></a>
|
|
34955
|
+
|
|
34956
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty
|
|
34957
|
+
|
|
34958
|
+
---
|
|
34959
|
+
|
|
34960
|
+
|
|
34961
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
34962
|
+
|
|
34963
|
+
| **Name** | **Description** |
|
|
34964
|
+
| --- | --- |
|
|
34965
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomation">ssmAutomation</a></code> | Specify the AutomationDocument to use for the action property. |
|
|
34966
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomationEscapeHatch">ssmAutomationEscapeHatch</a></code> | *No description.* |
|
|
34967
|
+
|
|
34968
|
+
---
|
|
34969
|
+
|
|
34970
|
+
##### `ssmAutomation` <a name="ssmAutomation" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomation"></a>
|
|
34971
|
+
|
|
34972
|
+
```typescript
|
|
34973
|
+
import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents'
|
|
34974
|
+
|
|
34975
|
+
IncidentResponseAction.ssmAutomation(automationDocument: AutomationDocument, role: Role, props?: SsmAutomationProps)
|
|
34976
|
+
```
|
|
34977
|
+
|
|
34978
|
+
Specify the AutomationDocument to use for the action property.
|
|
34979
|
+
|
|
34980
|
+
###### `automationDocument`<sup>Required</sup> <a name="automationDocument" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomation.parameter.automationDocument"></a>
|
|
34981
|
+
|
|
34982
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationDocument">AutomationDocument</a>
|
|
34983
|
+
|
|
34984
|
+
---
|
|
34985
|
+
|
|
34986
|
+
###### `role`<sup>Required</sup> <a name="role" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomation.parameter.role"></a>
|
|
34987
|
+
|
|
34988
|
+
- *Type:* aws-cdk-lib.aws_iam.Role
|
|
34989
|
+
|
|
34990
|
+
---
|
|
34991
|
+
|
|
34992
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomation.parameter.props"></a>
|
|
34993
|
+
|
|
34994
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.SsmAutomationProps">SsmAutomationProps</a>
|
|
34995
|
+
|
|
34996
|
+
---
|
|
34997
|
+
|
|
34998
|
+
##### `ssmAutomationEscapeHatch` <a name="ssmAutomationEscapeHatch" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomationEscapeHatch"></a>
|
|
34999
|
+
|
|
35000
|
+
```typescript
|
|
35001
|
+
import { IncidentResponseAction } from '@cdklabs/cdk-ssm-documents'
|
|
35002
|
+
|
|
35003
|
+
IncidentResponseAction.ssmAutomationEscapeHatch(ssmAutomationProperty: SsmAutomationProperty)
|
|
35004
|
+
```
|
|
35005
|
+
|
|
35006
|
+
###### `ssmAutomationProperty`<sup>Required</sup> <a name="ssmAutomationProperty" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.ssmAutomationEscapeHatch.parameter.ssmAutomationProperty"></a>
|
|
35007
|
+
|
|
35008
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.SsmAutomationProperty
|
|
35009
|
+
|
|
35010
|
+
---
|
|
35011
|
+
|
|
35012
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
35013
|
+
|
|
35014
|
+
| **Name** | **Type** | **Description** |
|
|
35015
|
+
| --- | --- | --- |
|
|
35016
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentResponseAction.property.cfnEntry">cfnEntry</a></code> | <code>aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty</code> | *No description.* |
|
|
35017
|
+
|
|
35018
|
+
---
|
|
35019
|
+
|
|
35020
|
+
##### `cfnEntry`<sup>Required</sup> <a name="cfnEntry" id="@cdklabs/cdk-ssm-documents.IncidentResponseAction.property.cfnEntry"></a>
|
|
35021
|
+
|
|
35022
|
+
```typescript
|
|
35023
|
+
public readonly cfnEntry: ActionProperty;
|
|
35024
|
+
```
|
|
35025
|
+
|
|
35026
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.ActionProperty
|
|
35027
|
+
|
|
35028
|
+
---
|
|
35029
|
+
|
|
35030
|
+
|
|
35031
|
+
### IncidentTemplate <a name="IncidentTemplate" id="@cdklabs/cdk-ssm-documents.IncidentTemplate"></a>
|
|
35032
|
+
|
|
35033
|
+
Provides L2 construct for https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html.
|
|
35034
|
+
|
|
35035
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer"></a>
|
|
35036
|
+
|
|
35037
|
+
```typescript
|
|
35038
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35039
|
+
|
|
35040
|
+
new IncidentTemplate(impact: number, title: string, props: IncidentTemplateProps)
|
|
35041
|
+
```
|
|
35042
|
+
|
|
35043
|
+
| **Name** | **Type** | **Description** |
|
|
35044
|
+
| --- | --- | --- |
|
|
35045
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.impact">impact</a></code> | <code>number</code> | *No description.* |
|
|
35046
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.title">title</a></code> | <code>string</code> | *No description.* |
|
|
35047
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a></code> | *No description.* |
|
|
35048
|
+
|
|
35049
|
+
---
|
|
35050
|
+
|
|
35051
|
+
##### `impact`<sup>Required</sup> <a name="impact" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.impact"></a>
|
|
35052
|
+
|
|
35053
|
+
- *Type:* number
|
|
35054
|
+
|
|
35055
|
+
---
|
|
35056
|
+
|
|
35057
|
+
##### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.title"></a>
|
|
35058
|
+
|
|
35059
|
+
- *Type:* string
|
|
35060
|
+
|
|
35061
|
+
---
|
|
35062
|
+
|
|
35063
|
+
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.Initializer.parameter.props"></a>
|
|
35064
|
+
|
|
35065
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35066
|
+
|
|
35067
|
+
---
|
|
35068
|
+
|
|
35069
|
+
|
|
35070
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
35071
|
+
|
|
35072
|
+
| **Name** | **Description** |
|
|
35073
|
+
| --- | --- |
|
|
35074
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.critical">critical</a></code> | Critical impact typically relates to full application failure that impacts many to all customers. |
|
|
35075
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.high">high</a></code> | High impact denotes partial application failure with impact to many customers. |
|
|
35076
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.low">low</a></code> | Low impact denotes that customers may not be impacted by the problem yet. |
|
|
35077
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.medium">medium</a></code> | Medium impact denotes that the application is providing reduced service to customers. |
|
|
35078
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.noImpact">noImpact</a></code> | No impact denotes that customers aren't currently impacted but urgent action is needed to avoid impact. |
|
|
35079
|
+
|
|
35080
|
+
---
|
|
35081
|
+
|
|
35082
|
+
##### `critical` <a name="critical" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.critical"></a>
|
|
35083
|
+
|
|
35084
|
+
```typescript
|
|
35085
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35086
|
+
|
|
35087
|
+
IncidentTemplate.critical(title: string, props: IncidentTemplateProps)
|
|
35088
|
+
```
|
|
35089
|
+
|
|
35090
|
+
Critical impact typically relates to full application failure that impacts many to all customers.
|
|
35091
|
+
|
|
35092
|
+
###### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.critical.parameter.title"></a>
|
|
35093
|
+
|
|
35094
|
+
- *Type:* string
|
|
35095
|
+
|
|
35096
|
+
---
|
|
35097
|
+
|
|
35098
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.critical.parameter.props"></a>
|
|
35099
|
+
|
|
35100
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35101
|
+
|
|
35102
|
+
---
|
|
35103
|
+
|
|
35104
|
+
##### `high` <a name="high" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.high"></a>
|
|
35105
|
+
|
|
35106
|
+
```typescript
|
|
35107
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35108
|
+
|
|
35109
|
+
IncidentTemplate.high(title: string, props: IncidentTemplateProps)
|
|
35110
|
+
```
|
|
35111
|
+
|
|
35112
|
+
High impact denotes partial application failure with impact to many customers.
|
|
35113
|
+
|
|
35114
|
+
###### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.high.parameter.title"></a>
|
|
35115
|
+
|
|
35116
|
+
- *Type:* string
|
|
35117
|
+
|
|
35118
|
+
---
|
|
35119
|
+
|
|
35120
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.high.parameter.props"></a>
|
|
35121
|
+
|
|
35122
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35123
|
+
|
|
35124
|
+
---
|
|
35125
|
+
|
|
35126
|
+
##### `low` <a name="low" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.low"></a>
|
|
35127
|
+
|
|
35128
|
+
```typescript
|
|
35129
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35130
|
+
|
|
35131
|
+
IncidentTemplate.low(title: string, props: IncidentTemplateProps)
|
|
35132
|
+
```
|
|
35133
|
+
|
|
35134
|
+
Low impact denotes that customers may not be impacted by the problem yet.
|
|
35135
|
+
|
|
35136
|
+
###### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.low.parameter.title"></a>
|
|
35137
|
+
|
|
35138
|
+
- *Type:* string
|
|
35139
|
+
|
|
35140
|
+
---
|
|
35141
|
+
|
|
35142
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.low.parameter.props"></a>
|
|
35143
|
+
|
|
35144
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35145
|
+
|
|
35146
|
+
---
|
|
35147
|
+
|
|
35148
|
+
##### `medium` <a name="medium" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.medium"></a>
|
|
35149
|
+
|
|
35150
|
+
```typescript
|
|
35151
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35152
|
+
|
|
35153
|
+
IncidentTemplate.medium(title: string, props: IncidentTemplateProps)
|
|
35154
|
+
```
|
|
35155
|
+
|
|
35156
|
+
Medium impact denotes that the application is providing reduced service to customers.
|
|
35157
|
+
|
|
35158
|
+
###### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.medium.parameter.title"></a>
|
|
35159
|
+
|
|
35160
|
+
- *Type:* string
|
|
35161
|
+
|
|
35162
|
+
---
|
|
35163
|
+
|
|
35164
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.medium.parameter.props"></a>
|
|
35165
|
+
|
|
35166
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35167
|
+
|
|
35168
|
+
---
|
|
35169
|
+
|
|
35170
|
+
##### `noImpact` <a name="noImpact" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.noImpact"></a>
|
|
35171
|
+
|
|
35172
|
+
```typescript
|
|
35173
|
+
import { IncidentTemplate } from '@cdklabs/cdk-ssm-documents'
|
|
35174
|
+
|
|
35175
|
+
IncidentTemplate.noImpact(title: string, props: IncidentTemplateProps)
|
|
35176
|
+
```
|
|
35177
|
+
|
|
35178
|
+
No impact denotes that customers aren't currently impacted but urgent action is needed to avoid impact.
|
|
35179
|
+
|
|
35180
|
+
###### `title`<sup>Required</sup> <a name="title" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.noImpact.parameter.title"></a>
|
|
35181
|
+
|
|
35182
|
+
- *Type:* string
|
|
35183
|
+
|
|
35184
|
+
---
|
|
35185
|
+
|
|
35186
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.noImpact.parameter.props"></a>
|
|
35187
|
+
|
|
35188
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IncidentTemplateProps">IncidentTemplateProps</a>
|
|
35189
|
+
|
|
35190
|
+
---
|
|
35191
|
+
|
|
35192
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
35193
|
+
|
|
35194
|
+
| **Name** | **Type** | **Description** |
|
|
35195
|
+
| --- | --- | --- |
|
|
35196
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IncidentTemplate.property.cfnEntry">cfnEntry</a></code> | <code>aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.IncidentTemplateProperty</code> | *No description.* |
|
|
35197
|
+
|
|
35198
|
+
---
|
|
35199
|
+
|
|
35200
|
+
##### `cfnEntry`<sup>Required</sup> <a name="cfnEntry" id="@cdklabs/cdk-ssm-documents.IncidentTemplate.property.cfnEntry"></a>
|
|
35201
|
+
|
|
35202
|
+
```typescript
|
|
35203
|
+
public readonly cfnEntry: IncidentTemplateProperty;
|
|
35204
|
+
```
|
|
35205
|
+
|
|
35206
|
+
- *Type:* aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.IncidentTemplateProperty
|
|
35207
|
+
|
|
35208
|
+
---
|
|
35209
|
+
|
|
35210
|
+
|
|
34535
35211
|
### InlineScriptCode <a name="InlineScriptCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode"></a>
|
|
34536
35212
|
|
|
34537
35213
|
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer"></a>
|