# SsmDocumentProperty

An AWS Systems Manager Document to execute as a post launch action.

- Source: Generated code
- Type last changed: v2.272.0 · 30 Sep 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mgn as mgn } from 'aws-cdk-lib';
const ssmDocumentProperty: mgn.CfnLaunchConfigurationTemplate.SsmDocumentProperty = {
  actionName: 'actionName',
  ssmDocumentName: 'ssmDocumentName',

  // the properties below are optional
  externalParameters: {
    externalParametersKey: {
      dynamicPath: 'dynamicPath',
    },
  },
  mustSucceedForCutover: false,
  parameters: {
    parametersKey: [{
      parameterName: 'parameterName',
      parameterType: 'parameterType',
    }],
  },
  timeoutSeconds: 123,
};
```

## Properties

- `actionName`: string (required) — User-friendly name for the AWS Systems Manager Document.

- `externalParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLaunchConfigurationTemplate.SsmExternalParameterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_mgn.CfnLaunchConfigurationTemplate.SsmExternalParameterProperty.html) } — AWS Systems Manager Document external parameters.

- `mustSucceedForCutover`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether Cutover is blocked when the document has failed.

- `parameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnLaunchConfigurationTemplate.SsmParameterStoreParameterProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_mgn.CfnLaunchConfigurationTemplate.SsmParameterStoreParameterProperty.html)[] } — AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.

- `ssmDocumentName`: string (required) — AWS Systems Manager Document name or full ARN.

- `timeoutSeconds`: number — AWS Systems Manager Document timeout, in seconds.
