Package software.amazon.awscdk.services.ssmincidents

Interface CfnResponsePlan.SsmAutomationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResponsePlan.SsmAutomationProperty.Jsii$Proxy

Enclosing class:

CfnResponsePlan

@Stability(Stable)
public static interface CfnResponsePlan.SsmAutomationProperty
extends software.amazon.jsii.JsiiSerializable

The SsmAutomation property type specifies details about the Systems Manager Automation runbook that will be used as the runbook during an incident.

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.ssmincidents.*;
 SsmAutomationProperty ssmAutomationProperty = SsmAutomationProperty.builder()
         .documentName("documentName")
         .roleArn("roleArn")
         // the properties below are optional
         .documentVersion("documentVersion")
         .dynamicParameters(List.of(DynamicSsmParameterProperty.builder()
                 .key("key")
                 .value(DynamicSsmParameterValueProperty.builder()
                         .variable("variable")
                         .build())
                 .build()))
         .parameters(List.of(SsmParameterProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .targetAccount("targetAccount")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResponsePlan.SsmAutomationProperty.Builder	builder()
String	getDocumentName()	The automation document's name.
default String	getDocumentVersion()	The version of the runbook to use when running.
default Object	getDynamicParameters()	The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
default Object	getParameters()	The key-value pair parameters to use when running the runbook.
String	getRoleArn()	The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
default String	getTargetAccount()	The account that the automation document will be run in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDocumentName

@Stability(Stable)
@NotNull
String getDocumentName()

The automation document's name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentname

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-rolearn

getDocumentVersion

@Stability(Stable)
@Nullable
default String getDocumentVersion()

The version of the runbook to use when running.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentversion

getDynamicParameters

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

The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-dynamicparameters

getParameters

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

The key-value pair parameters to use when running the runbook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-parameters

getTargetAccount

@Stability(Stable)
@Nullable
default String getTargetAccount()

The account that the automation document will be run in.

This can be in either the management account or an application account.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-targetaccount

builder

@Stability(Stable)
static CfnResponsePlan.SsmAutomationProperty.Builder builder()

Returns:

a CfnResponsePlan.SsmAutomationProperty.Builder of CfnResponsePlan.SsmAutomationProperty