software.amazon.awscdk.services.ssmincidents

Class CfnResponsePlan

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ssmincidents.CfnResponsePlan

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:19.367Z")
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"))
         .integrations(List.of(IntegrationProperty.builder()
                 .pagerDutyConfiguration(PagerDutyConfigurationProperty.builder()
                         .name("name")
                         .pagerDutyIncidentConfiguration(PagerDutyIncidentConfigurationProperty.builder()
                                 .serviceId("serviceId")
                                 .build())
                         .secretId("secretId")
                         .build())
                 .build()))
         .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 When you add a runbook to a response plan, you can specify the parameters the runbook should use at runtime.
static interface	CfnResponsePlan.DynamicSsmParameterValueProperty The dynamic parameter value.
static interface	CfnResponsePlan.IncidentTemplateProperty The `IncidentTemplate` property type specifies details used to create an incident when using this response plan.
static interface	CfnResponsePlan.IntegrationProperty Information about third-party services integrated into a response plan.
static interface	CfnResponsePlan.NotificationTargetItemProperty The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.
static interface	CfnResponsePlan.PagerDutyConfigurationProperty Details about the PagerDuty configuration for a response plan.
static interface	CfnResponsePlan.PagerDutyIncidentConfigurationProperty Example:
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResponsePlan(Construct scope, java.lang.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
java.lang.Object	getActions() The actions that the response plan starts at the beginning of an incident.
java.lang.String	getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getChatChannel() The AWS Chatbot chat channel used for collaboration during an incident.
java.lang.String	getDisplayName() The human readable name of the response plan.
java.util.List<java.lang.String>	getEngagements() The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
java.lang.Object	getIncidentTemplate() Details used to create an incident when using this response plan.
java.lang.Object	getIntegrations() Information about third-party services integrated into the response plan.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setActions(IResolvable value) The actions that the response plan starts at the beginning of an incident.
void	setActions(java.util.List<java.lang.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(java.lang.String value) The human readable name of the response plan.
void	setEngagements(java.util.List<java.lang.String> value) The Amazon Resource Name (ARN) for 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	setIntegrations(IResolvable value) Information about third-party services integrated into the response plan.
void	setIntegrations(java.util.List<java.lang.Object> value) Information about third-party services integrated into the response plan.
void	setName(java.lang.String value) The name of the response plan.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnResponsePlan(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getIncidentTemplate

public java.lang.Object getIncidentTemplate()

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

setIncidentTemplate

public void setIncidentTemplate(IResolvable value)

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

setIncidentTemplate

public void setIncidentTemplate(CfnResponsePlan.IncidentTemplateProperty value)

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

getName

public java.lang.String getName()

The name of the response plan.

setName

public void setName(java.lang.String value)

The name of the response plan.

getActions

public java.lang.Object getActions()

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

setActions

public void setActions(IResolvable value)

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

setActions

public void setActions(java.util.List<java.lang.Object> value)

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

getChatChannel

public java.lang.Object getChatChannel()

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

setChatChannel

public void setChatChannel(IResolvable value)

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

setChatChannel

public void setChatChannel(CfnResponsePlan.ChatChannelProperty value)

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

getDisplayName

public java.lang.String getDisplayName()

The human readable name of the response plan.

setDisplayName

public void setDisplayName(java.lang.String value)

The human readable name of the response plan.

getEngagements

public java.util.List<java.lang.String> getEngagements()

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

setEngagements

public void setEngagements(java.util.List<java.lang.String> value)

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

getIntegrations

public java.lang.Object getIntegrations()

Information about third-party services integrated into the response plan.

setIntegrations

public void setIntegrations(IResolvable value)

Information about third-party services integrated into the response plan.

setIntegrations

public void setIntegrations(java.util.List<java.lang.Object> value)

Information about third-party services integrated into the response plan.