software.amazon.awscdk.services.ssmincidents

Class CfnResponsePlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssmincidents.CfnResponsePlan

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.343Z")
 @Stability(value=Stable)
public class CfnResponsePlan
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSMIncidents::ResponsePlan`.

The AWS::SSMIncidents::ResponsePlan resource specifies the details of the response plan that are used when creating 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.*;
 CfnResponsePlan cfnResponsePlan = CfnResponsePlan.Builder.create(this, "MyCfnResponsePlan")
         .incidentTemplate(IncidentTemplateProperty.builder()
                 .impact(123)
                 .title("title")
                 // the properties below are optional
                 .dedupeString("dedupeString")
                 .incidentTags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .notificationTargets(List.of(NotificationTargetItemProperty.builder()
                         .snsTopicArn("snsTopicArn")
                         .build()))
                 .summary("summary")
                 .build())
         .name("name")
         // the properties below are optional
         .actions(List.of(ActionProperty.builder()
                 .ssmAutomation(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())
                 .build()))
         .chatChannel(ChatChannelProperty.builder()
                 .chatbotSns(List.of("chatbotSns"))
                 .build())
         .displayName("displayName")
         .engagements(List.of("engagements"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnResponsePlan.ActionProperty The `Action` property type specifies the configuration to launch.
static class	CfnResponsePlan.Builder A fluent builder for CfnResponsePlan.
static interface	CfnResponsePlan.ChatChannelProperty The AWS Chatbot chat channel used for collaboration during an incident.
static interface	CfnResponsePlan.DynamicSsmParameterProperty Example:
static interface	CfnResponsePlan.DynamicSsmParameterValueProperty Example:
static interface	CfnResponsePlan.IncidentTemplateProperty The `IncidentTemplate` property type specifies details used to create an incident when using this response plan.
static interface	CfnResponsePlan.NotificationTargetItemProperty The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
static interface	CfnResponsePlan.SsmAutomationProperty The `SsmAutomation` property type specifies details about the Systems Manager automation document that will be used as a runbook during an incident.
static interface	CfnResponsePlan.SsmParameterProperty The key-value pair parameters to use when running the automation document.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResponsePlan(software.constructs.Construct scope, String id, CfnResponsePlanProps props) Create a new `AWS::SSMIncidents::ResponsePlan`.
protected	CfnResponsePlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResponsePlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActions() The actions that the response plan starts at the beginning of an incident.
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
Object	getChatChannel() The AWS Chatbot chat channel used for collaboration during an incident.
String	getDisplayName() The human readable name of the response plan.
List<String>	getEngagements() The contacts and escalation plans that the response plan engages during an incident.
Object	getIncidentTemplate() Details used to create an incident when using this response plan.
String	getName() The name of the response plan.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(IResolvable value) The actions that the response plan starts at the beginning of an incident.
void	setActions(List<Object> value) The actions that the response plan starts at the beginning of an incident.
void	setChatChannel(CfnResponsePlan.ChatChannelProperty value) The AWS Chatbot chat channel used for collaboration during an incident.
void	setChatChannel(IResolvable value) The AWS Chatbot chat channel used for collaboration during an incident.
void	setDisplayName(String value) The human readable name of the response plan.
void	setEngagements(List<String> value) The contacts and escalation plans that the response plan engages during an incident.
void	setIncidentTemplate(CfnResponsePlan.IncidentTemplateProperty value) Details used to create an incident when using this response plan.
void	setIncidentTemplate(IResolvable value) Details used to create an incident when using this response plan.
void	setName(String value) The name of the response plan.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResponsePlan

protected CfnResponsePlan(software.amazon.jsii.JsiiObjectRef objRef)

CfnResponsePlan

protected CfnResponsePlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResponsePlan

@Stability(value=Stable)
public CfnResponsePlan(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnResponsePlanProps props)

Create a new `AWS::SSMIncidents::ResponsePlan`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getIncidentTemplate

@Stability(value=Stable)
 @NotNull
public Object getIncidentTemplate()

Details used to create an incident when using this response plan.

setIncidentTemplate

@Stability(value=Stable)
public void setIncidentTemplate(@NotNull
                                                         CfnResponsePlan.IncidentTemplateProperty value)

Details used to create an incident when using this response plan.

setIncidentTemplate

@Stability(value=Stable)
public void setIncidentTemplate(@NotNull
                                                         IResolvable value)

Details used to create an incident when using this response plan.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the response plan.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the response plan.

getActions

@Stability(value=Stable)
 @Nullable
public Object getActions()

The actions that the response plan starts at the beginning of an incident.

setActions

@Stability(value=Stable)
public void setActions(@Nullable
                                                IResolvable value)

The actions that the response plan starts at the beginning of an incident.

setActions

@Stability(value=Stable)
public void setActions(@Nullable
                                                List<Object> value)

The actions that the response plan starts at the beginning of an incident.

getChatChannel

@Stability(value=Stable)
 @Nullable
public Object getChatChannel()

The AWS Chatbot chat channel used for collaboration during an incident.

setChatChannel

@Stability(value=Stable)
public void setChatChannel(@Nullable
                                                    CfnResponsePlan.ChatChannelProperty value)

The AWS Chatbot chat channel used for collaboration during an incident.

setChatChannel

@Stability(value=Stable)
public void setChatChannel(@Nullable
                                                    IResolvable value)

The AWS Chatbot chat channel used for collaboration during an incident.

getDisplayName

@Stability(value=Stable)
 @Nullable
public String getDisplayName()

The human readable name of the response plan.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@Nullable
                                                    String value)

The human readable name of the response plan.

getEngagements

@Stability(value=Stable)
 @Nullable
public List<String> getEngagements()

The contacts and escalation plans that the response plan engages during an incident.

setEngagements

@Stability(value=Stable)
public void setEngagements(@Nullable
                                                    List<String> value)

The contacts and escalation plans that the response plan engages during an incident.