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(value=Stable)
public static interface CfnResponsePlan.SsmAutomationProperty
extends software.amazon.jsii.JsiiSerializable

The `SsmAutomation` property type specifies details about the Systems Manager automation document that will be used as a 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnResponsePlan.SsmAutomationProperty.Builder	builder()
String	getDocumentName() The automation document's name.
default String	getDocumentVersion() The automation document's version to use when running.
default Object	getDynamicParameters() `CfnResponsePlan.SsmAutomationProperty.DynamicParameters`.
default Object	getParameters() The key-value pair parameters to use when running the automation document.
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 Detail

getDocumentName

@Stability(value=Stable)
 @NotNull
String getDocumentName()

The automation document's name.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

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

getDocumentVersion

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

The automation document's version to use when running.

getDynamicParameters

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

`CfnResponsePlan.SsmAutomationProperty.DynamicParameters`.

getParameters

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

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

getTargetAccount

@Stability(value=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.

builder

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

Returns:

a CfnResponsePlan.SsmAutomationProperty.Builder of CfnResponsePlan.SsmAutomationProperty