Package software.amazon.awscdk.cfnpropertymixins.services.ssmincidents

Interface CfnResponsePlanPropsMixin.IncidentTemplateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResponsePlanPropsMixin.IncidentTemplateProperty.Jsii$Proxy

Enclosing class:

CfnResponsePlanPropsMixin

@Stability(Stable)
public static interface CfnResponsePlanPropsMixin.IncidentTemplateProperty
extends software.amazon.jsii.JsiiSerializable

The IncidentTemplate property type specifies details used to create an incident when using this response plan.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssmincidents.*;
 IncidentTemplateProperty incidentTemplateProperty = IncidentTemplateProperty.builder()
         .dedupeString("dedupeString")
         .impact(123)
         .incidentTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .notificationTargets(List.of(NotificationTargetItemProperty.builder()
                 .snsTopicArn("snsTopicArn")
                 .build()))
         .summary("summary")
         .title("title")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResponsePlanPropsMixin.IncidentTemplateProperty.Builder	builder()
default String	getDedupeString()	Used to create only one incident record for an incident.
default Number	getImpact()	Defines the impact to the customers.
default Object	getIncidentTags()	Tags to assign to the template.
default Object	getNotificationTargets()	The Amazon Simple Notification Service ( Amazon ) targets that uses to notify the chat channel of updates to an incident.
default String	getSummary()	The summary describes what has happened during the incident.
default String	getTitle()	The title of the incident is a brief and easily recognizable.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDedupeString

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

Used to create only one incident record for an incident.

See Also:

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

getImpact

@Stability(Stable)
@Nullable
default Number getImpact()

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts: - 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

• 2 - High impact, partial application failure with impact to many customers.
• 3 - Medium impact, the application is providing reduced service to customers.
• 4 - Low impact, customer might aren't impacted by the problem yet.
• 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

See Also:

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

getIncidentTags

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

Tags to assign to the template.

When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

See Also:

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

getNotificationTargets

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

The Amazon Simple Notification Service ( Amazon ) targets that uses to notify the chat channel of updates to an incident.

You can also make updates to the incident through the chat channel using the Amazon topics.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnResponsePlanPropsMixin.NotificationTargetItemProperty>

See Also:

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

getSummary

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

The summary describes what has happened during the incident.

See Also:

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

getTitle

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

The title of the incident is a brief and easily recognizable.

See Also:

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

builder

@Stability(Stable)
static CfnResponsePlanPropsMixin.IncidentTemplateProperty.Builder builder()

Returns:

a CfnResponsePlanPropsMixin.IncidentTemplateProperty.Builder of CfnResponsePlanPropsMixin.IncidentTemplateProperty