CfnResponsePlanProps

class aws_cdk.aws_ssmincidents.CfnResponsePlanProps(*, incident_template, name, actions=None, chat_channel=None, display_name=None, engagements=None, tags=None)

Bases: object

Properties for defining a CfnResponsePlan.

Parameters
  • incident_template (Union[IResolvable, IncidentTemplateProperty, Dict[str, Any]]) – Details used to create an incident when using this response plan.

  • name (str) – The name of the response plan.

  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty, Dict[str, Any]]], None]) – The actions that the response plan starts at the beginning of an incident.

  • chat_channel (Union[IResolvable, ChatChannelProperty, Dict[str, Any], None]) – The AWS Chatbot chat channel used for collaboration during an incident.

  • display_name (Optional[str]) – The human readable name of the response plan.

  • engagements (Optional[Sequence[str]]) – The contacts and escalation plans that the response plan engages during an incident.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssmincidents as ssmincidents

cfn_response_plan_props = ssmincidents.CfnResponsePlanProps(
    incident_template=ssmincidents.CfnResponsePlan.IncidentTemplateProperty(
        impact=123,
        title="title",

        # the properties below are optional
        dedupe_string="dedupeString",
        incident_tags=[CfnTag(
            key="key",
            value="value"
        )],
        notification_targets=[ssmincidents.CfnResponsePlan.NotificationTargetItemProperty(
            sns_topic_arn="snsTopicArn"
        )],
        summary="summary"
    ),
    name="name",

    # the properties below are optional
    actions=[ssmincidents.CfnResponsePlan.ActionProperty(
        ssm_automation=ssmincidents.CfnResponsePlan.SsmAutomationProperty(
            document_name="documentName",
            role_arn="roleArn",

            # the properties below are optional
            document_version="documentVersion",
            dynamic_parameters=[ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty(
                key="key",
                value=ssmincidents.CfnResponsePlan.DynamicSsmParameterValueProperty(
                    variable="variable"
                )
            )],
            parameters=[ssmincidents.CfnResponsePlan.SsmParameterProperty(
                key="key",
                values=["values"]
            )],
            target_account="targetAccount"
        )
    )],
    chat_channel=ssmincidents.CfnResponsePlan.ChatChannelProperty(
        chatbot_sns=["chatbotSns"]
    ),
    display_name="displayName",
    engagements=["engagements"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

actions

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ActionProperty]], None]

chat_channel

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

Link

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

Return type

Union[IResolvable, ChatChannelProperty, None]

display_name

The human readable name of the response plan.

Link

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

Return type

Optional[str]

engagements

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

Link

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

Return type

Optional[List[str]]

incident_template

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

Link

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

Return type

Union[IResolvable, IncidentTemplateProperty]

name

The name of the response plan.

Link

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

Return type

str

tags

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

For more information, see Tag .

Link

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

Return type

Optional[List[CfnTag]]