interface SsmDocumentProperty

Language	Type name
.NET	Amazon.CDK.AWS.MGN.CfnLaunchConfigurationTemplate.SsmDocumentProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmgn#CfnLaunchConfigurationTemplate_SsmDocumentProperty
Java	software.amazon.awscdk.services.mgn.CfnLaunchConfigurationTemplate.SsmDocumentProperty
Python	aws_cdk.aws_mgn.CfnLaunchConfigurationTemplate.SsmDocumentProperty
TypeScript	aws-cdk-lib » aws_mgn » CfnLaunchConfigurationTemplate » SsmDocumentProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html

Example

// 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

Name	Type	Description
actionName	string	User-friendly name for the AWS Systems Manager Document.
ssmDocumentName	string	AWS Systems Manager Document name or full ARN.
externalParameters?	IResolvable | { [string]: IResolvable | SsmExternalParameterProperty }	AWS Systems Manager Document external parameters.
mustSucceedForCutover?	boolean | IResolvable	Whether Cutover is blocked when the document has failed.
parameters?	IResolvable | { [string]: IResolvable | (IResolvable | SsmParameterStoreParameterProperty)[] }	AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.
timeoutSeconds?	number	AWS Systems Manager Document timeout, in seconds.

---

actionName

Type: string

User-friendly name for the AWS Systems Manager Document.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-actionname

---

ssmDocumentName

Type: string

AWS Systems Manager Document name or full ARN.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-ssmdocumentname

---

externalParameters?

Type: IResolvable | { [string]: IResolvable | SsmExternalParameterProperty } (optional)

AWS Systems Manager Document external parameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-externalparameters

---

mustSucceedForCutover?

Type: boolean | IResolvable (optional)

Whether Cutover is blocked when the document has failed.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-mustsucceedforcutover

---

parameters?

Type: IResolvable | { [string]: IResolvable | (IResolvable | SsmParameterStoreParameterProperty)[] } (optional)

AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-parameters

---

timeoutSeconds?

Type: number (optional)

AWS Systems Manager Document timeout, in seconds.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-timeoutseconds