Package 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, IEnvironmentAware, IResponsePlanRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:30.345Z") @Stability(Stable) public class CfnResponsePlan extends CfnResource implements IInspectable, IResponsePlanRef, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnResponsePlan

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

    • CfnResponsePlan

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

    • CfnResponsePlan

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForResponsePlan

      @Stability(Stable) @NotNull public static String arnForResponsePlan(@NotNull IResponsePlanRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnResponsePlan

      @Stability(Stable) @NotNull public static Boolean isCfnResponsePlan(@NotNull Object x)
      Checks whether the given object is a CfnResponsePlan.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of the response plan.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getResponsePlanRef

      @Stability(Stable) @NotNull public ResponsePlanReference getResponsePlanRef()
      A reference to a ResponsePlan resource.
      Specified by:
      getResponsePlanRef in interface IResponsePlanRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getIncidentTemplate

      @Stability(Stable) @NotNull public Object getIncidentTemplate()
      Details used to create an incident when using this response plan.

      Returns union: either IResolvable or CfnResponsePlan.IncidentTemplateProperty

    • setIncidentTemplate

      @Stability(Stable) public void setIncidentTemplate(@NotNull IResolvable value)
      Details used to create an incident when using this response plan.

    • setIncidentTemplate

      @Stability(Stable) public void setIncidentTemplate(@NotNull CfnResponsePlan.IncidentTemplateProperty value)
      Details used to create an incident when using this response plan.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the response plan.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the response plan.

    • getActions

      @Stability(Stable) @Nullable public Object getActions()
      The actions that the response plan starts at the beginning of an incident.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnResponsePlan.ActionProperty>

    • setActions

      @Stability(Stable) public void setActions(@Nullable IResolvable value)
      The actions that the response plan starts at the beginning of an incident.

    • setActions

      @Stability(Stable) public void setActions(@Nullable List<Object> value)
      The actions that the response plan starts at the beginning of an incident.

    • getChatChannel

      @Stability(Stable) @Nullable public Object getChatChannel()
      The chat channel used for collaboration during an incident.

      Returns union: either IResolvable or CfnResponsePlan.ChatChannelProperty

    • setChatChannel

      @Stability(Stable) public void setChatChannel(@Nullable IResolvable value)
      The chat channel used for collaboration during an incident.

    • setChatChannel

      @Stability(Stable) public void setChatChannel(@Nullable CfnResponsePlan.ChatChannelProperty value)
      The chat channel used for collaboration during an incident.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The human readable name of the response plan.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The human readable name of the response plan.

    • getEngagements

      @Stability(Stable) @Nullable public List<String> getEngagements()
      The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

    • setEngagements

      @Stability(Stable) public void setEngagements(@Nullable List<String> value)
      The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

    • getIntegrations

      @Stability(Stable) @Nullable public Object getIntegrations()
      Information about third-party services integrated into the response plan.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnResponsePlan.IntegrationProperty>

    • setIntegrations

      @Stability(Stable) public void setIntegrations(@Nullable IResolvable value)
      Information about third-party services integrated into the response plan.

    • setIntegrations

      @Stability(Stable) public void setIntegrations(@Nullable List<Object> value)
      Information about third-party services integrated into the response plan.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.