Package software.amazon.awscdk.services.mgn

Interface CfnLaunchConfigurationTemplate.SsmDocumentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchConfigurationTemplate.SsmDocumentProperty.Jsii$Proxy

Enclosing class:

CfnLaunchConfigurationTemplate

@Stability(Stable)
public static interface CfnLaunchConfigurationTemplate.SsmDocumentProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mgn.*;
 SsmDocumentProperty ssmDocumentProperty = SsmDocumentProperty.builder()
         .actionName("actionName")
         .ssmDocumentName("ssmDocumentName")
         // the properties below are optional
         .externalParameters(Map.of(
                 "externalParametersKey", SsmExternalParameterProperty.builder()
                         .dynamicPath("dynamicPath")
                         .build()))
         .mustSucceedForCutover(false)
         .parameters(Map.of(
                 "parametersKey", List.of(SsmParameterStoreParameterProperty.builder()
                         .parameterName("parameterName")
                         .parameterType("parameterType")
                         .build())))
         .timeoutSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLaunchConfigurationTemplate.SsmDocumentProperty.Builder	A builder for CfnLaunchConfigurationTemplate.SsmDocumentProperty
static final class	CfnLaunchConfigurationTemplate.SsmDocumentProperty.Jsii$Proxy	An implementation for CfnLaunchConfigurationTemplate.SsmDocumentProperty

Method Summary

Modifier and Type	Method	Description
static CfnLaunchConfigurationTemplate.SsmDocumentProperty.Builder	builder()
String	getActionName()	User-friendly name for the AWS Systems Manager Document.
default Object	getExternalParameters()	AWS Systems Manager Document external parameters.
default Object	getMustSucceedForCutover()	Whether Cutover is blocked when the document has failed.
default Object	getParameters()	AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.
String	getSsmDocumentName()	AWS Systems Manager Document name or full ARN.
default Number	getTimeoutSeconds()	AWS Systems Manager Document timeout, in seconds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionName

@Stability(Stable)
@NotNull
String getActionName()

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

getSsmDocumentName

@Stability(Stable)
@NotNull
String getSsmDocumentName()

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

getExternalParameters

@Stability(Stable)
@Nullable
default Object getExternalParameters()

AWS Systems Manager Document external parameters.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnLaunchConfigurationTemplate.SsmExternalParameterProperty>

See Also:

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

getMustSucceedForCutover

@Stability(Stable)
@Nullable
default Object getMustSucceedForCutover()

Whether Cutover is blocked when the document has failed.

Returns union: either Boolean or IResolvable

See Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or Listinvalid input: '<'either IResolvable or CfnLaunchConfigurationTemplate.SsmParameterStoreParameterProperty>>

See Also:

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

getTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getTimeoutSeconds()

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

builder

@Stability(Stable)
static CfnLaunchConfigurationTemplate.SsmDocumentProperty.Builder builder()

Returns:

a CfnLaunchConfigurationTemplate.SsmDocumentProperty.Builder of CfnLaunchConfigurationTemplate.SsmDocumentProperty