Package software.amazon.awscdk.services.ssmincidents

Interface CfnResponsePlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResponsePlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.309Z")
@Stability(Stable)
public interface CfnResponsePlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResponsePlan.

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.*;
 CfnResponsePlanProps cfnResponsePlanProps = CfnResponsePlanProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResponsePlanProps.Builder	builder()
default Object	getActions()	The actions that the response plan starts at the beginning of an incident.
default Object	getChatChannel()	The AWS Chatbot chat channel used for collaboration during an incident.
default String	getDisplayName()	The human readable name of the response plan.
default List<String>	getEngagements()	The Amazon Resource Name (ARN) for 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.
default Object	getIntegrations()	Information about third-party services integrated into the response plan.
String	getName()	The name of the response plan.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIncidentTemplate

@Stability(Stable)
@NotNull
Object getIncidentTemplate()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-incidenttemplate

getName

@Stability(Stable)
@NotNull
String getName()

The name of the response plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-name

getActions

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-actions

getChatChannel

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-chatchannel

getDisplayName

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

The human readable name of the response plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-displayname

getEngagements

@Stability(Stable)
@Nullable
default List<String> getEngagements()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-engagements

getIntegrations

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-integrations

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html#cfn-ssmincidents-responseplan-tags

builder

@Stability(Stable)
static CfnResponsePlanProps.Builder builder()

Returns:

a CfnResponsePlanProps.Builder of CfnResponsePlanProps