AWS CDK Reference

Appearance

v2.273.0

SsmDocumentProperty Struct ​

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 ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
User-friendly name for the AWS Systems Manager Document.
externalParametersIResolvable | { [key: string]: IResolvable | CfnLaunchConfigurationTemplate.SsmExternalParameterProperty }external_parameterstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, SsmExternalParameterProperty]]]externalParametersIResolvableExternalParametersIResolvableExternalParametersinterface{}#
AWS Systems Manager Document external parameters.
mustSucceedForCutoverboolean | IResolvablemust_succeed_for_cutovertyping.Union[bool, IResolvable]mustSucceedForCutoverBooleanMustSucceedForCutoverboolMustSucceedForCutoverinterface{}#
Whether Cutover is blocked when the document has failed.
parametersIResolvable | { [key: string]: IResolvable | IResolvable | CfnLaunchConfigurationTemplate.SsmParameterStoreParameterProperty[] }parameterstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SsmParameterStoreParameterProperty]]]]]parametersIResolvableParametersIResolvableParametersinterface{}#
AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.
ssmDocumentNamestringssm_document_namestrssmDocumentNameStringSsmDocumentNamestringSsmDocumentName*stringrequired#
AWS Systems Manager Document name or full ARN.
timeoutSecondsnumbertimeout_secondsint | floattimeoutSecondsNumberTimeoutSecondsdoubleTimeoutSeconds*float64#
AWS Systems Manager Document timeout, in seconds.