CfnResponsePlanPropsMixin

class aws_cdk.mixins_preview.aws_ssmincidents.mixins.CfnResponsePlanPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SSMIncidents::ResponsePlan resource specifies the details of the response plan that are used when creating an incident.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmincidents-responseplan.html
CloudformationResource:: AWS::SSMIncidents::ResponsePlan
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_response_plan_props_mixin = ssmincidents_mixins.CfnResponsePlanPropsMixin(ssmincidents_mixins.CfnResponsePlanMixinProps(
    actions=[ssmincidents_mixins.CfnResponsePlanPropsMixin.ActionProperty(
        ssm_automation=ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty(
            document_name="documentName",
            document_version="documentVersion",
            dynamic_parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterProperty(
                key="key",
                value=ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(
                    variable="variable"
                )
            )],
            parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmParameterProperty(
                key="key",
                values=["values"]
            )],
            role_arn="roleArn",
            target_account="targetAccount"
        )
    )],
    chat_channel=ssmincidents_mixins.CfnResponsePlanPropsMixin.ChatChannelProperty(
        chatbot_sns=["chatbotSns"]
    ),
    display_name="displayName",
    engagements=["engagements"],
    incident_template=ssmincidents_mixins.CfnResponsePlanPropsMixin.IncidentTemplateProperty(
        dedupe_string="dedupeString",
        impact=123,
        incident_tags=[CfnTag(
            key="key",
            value="value"
        )],
        notification_targets=[ssmincidents_mixins.CfnResponsePlanPropsMixin.NotificationTargetItemProperty(
            sns_topic_arn="snsTopicArn"
        )],
        summary="summary",
        title="title"
    ),
    integrations=[ssmincidents_mixins.CfnResponsePlanPropsMixin.IntegrationProperty(
        pager_duty_configuration=ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyConfigurationProperty(
            name="name",
            pager_duty_incident_configuration=ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyIncidentConfigurationProperty(
                service_id="serviceId"
            ),
            secret_id="secretId"
        )
    )],
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSMIncidents::ResponsePlan.

Parameters:

props (Union[CfnResponsePlanMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['actions', 'chatChannel', 'displayName', 'engagements', 'incidentTemplate', 'integrations', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActionProperty

class CfnResponsePlanPropsMixin.ActionProperty(*, ssm_automation=None)

Bases: object

The Action property type specifies the configuration to launch.

Parameters:: ssm_automation (Union[IResolvable, SsmAutomationProperty, Dict[str, Any], None]) – Details about the Systems Manager automation document that will be used as a runbook during an incident.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html
ExampleMetadata:: fixture=_generated

Example:

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

action_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.ActionProperty(
    ssm_automation=ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty(
        document_name="documentName",
        document_version="documentVersion",
        dynamic_parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterProperty(
            key="key",
            value=ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(
                variable="variable"
            )
        )],
        parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmParameterProperty(
            key="key",
            values=["values"]
        )],
        role_arn="roleArn",
        target_account="targetAccount"
    )
)

Attributes

ssm_automation

Details about the Systems Manager automation document that will be used as a runbook during an incident.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html#cfn-ssmincidents-responseplan-action-ssmautomation

ChatChannelProperty

class CfnResponsePlanPropsMixin.ChatChannelProperty(*, chatbot_sns=None)

Bases: object

The chat channel used for collaboration during an incident.

Parameters:: chatbot_sns (Optional[Sequence[str]]) – The 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 by using the Amazon topics
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-chatchannel.html
ExampleMetadata:: fixture=_generated

Example:

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

chat_channel_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.ChatChannelProperty(
    chatbot_sns=["chatbotSns"]
)

Attributes

chatbot_sns

The 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 by using the Amazon topics

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

DynamicSsmParameterProperty

class CfnResponsePlanPropsMixin.DynamicSsmParameterProperty(*, key=None, value=None)

Bases: object

When you add a runbook to a response plan, you can specify the parameters for the runbook to use at runtime.

Response plans support parameters with both static and dynamic values. For static values, you enter the value when you define the parameter in the response plan. For dynamic values, the system determines the correct parameter value by collecting information from the incident. Incident Manager supports the following dynamic parameters:

Incident ARN

When Incident Manager creates an incident, the system captures the Amazon Resource Name (ARN) of the corresponding incident record and enters it for this parameter in the runbook. .. epigraph:

This value can only be assigned to parameters of type ``String`` . If assigned to a parameter of any other type, the runbook fails to run.

Involved resources

When Incident Manager creates an incident, the system captures the ARNs of the resources involved in the incident. These resource ARNs are then assigned to this parameter in the runbook. .. epigraph:

This value can only be assigned to parameters of type ``StringList`` . If assigned to a parameter of any other type, the runbook fails to run.

Parameters:

key (Optional[str]) – The key parameter to use when running the Systems Manager Automation runbook.
value (Union[IResolvable, DynamicSsmParameterValueProperty, Dict[str, Any], None]) – The dynamic parameter value.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

dynamic_ssm_parameter_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterProperty(
    key="key",
    value=ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(
        variable="variable"
    )
)

Attributes

key

The key parameter to use when running the Systems Manager Automation runbook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html#cfn-ssmincidents-responseplan-dynamicssmparameter-key

value

The dynamic parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html#cfn-ssmincidents-responseplan-dynamicssmparameter-value

DynamicSsmParameterValueProperty

class CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(*, variable=None)

Bases: object

The dynamic parameter value.

Parameters:: variable (Optional[str]) – Variable dynamic parameters. A parameter value is determined when an incident is created.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html
ExampleMetadata:: fixture=_generated

Example:

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

dynamic_ssm_parameter_value_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(
    variable="variable"
)

Attributes

variable

Variable dynamic parameters.

A parameter value is determined when an incident is created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html#cfn-ssmincidents-responseplan-dynamicssmparametervalue-variable

IncidentTemplateProperty

class CfnResponsePlanPropsMixin.IncidentTemplateProperty(*, dedupe_string=None, impact=None, incident_tags=None, notification_targets=None, summary=None, title=None)

Bases: object

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

Parameters:

dedupe_string (Optional[str]) – Used to create only one incident record for an incident.
impact (Union[int, float, None]) – 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.
incident_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – 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.
notification_targets (Union[IResolvable, Sequence[Union[IResolvable, NotificationTargetItemProperty, Dict[str, Any]]], None]) – 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.
summary (Optional[str]) – The summary describes what has happened during the incident.
title (Optional[str]) – The title of the incident is a brief and easily recognizable.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

incident_template_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.IncidentTemplateProperty(
    dedupe_string="dedupeString",
    impact=123,
    incident_tags=[CfnTag(
        key="key",
        value="value"
    )],
    notification_targets=[ssmincidents_mixins.CfnResponsePlanPropsMixin.NotificationTargetItemProperty(
        sns_topic_arn="snsTopicArn"
    )],
    summary="summary",
    title="title"
)

Attributes

dedupe_string

Used to create only one incident record for an incident.

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

impact

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html#cfn-ssmincidents-responseplan-incidenttemplate-impact

incident_tags

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.

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

notification_targets

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.

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

summary

The summary describes what has happened during the incident.

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

title

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

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

IntegrationProperty

class CfnResponsePlanPropsMixin.IntegrationProperty(*, pager_duty_configuration=None)

Bases: object

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

Parameters:: pager_duty_configuration (Union[IResolvable, PagerDutyConfigurationProperty, Dict[str, Any], None]) – Information about the PagerDuty service where the response plan creates an incident.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html
ExampleMetadata:: fixture=_generated

Example:

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

integration_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.IntegrationProperty(
    pager_duty_configuration=ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyConfigurationProperty(
        name="name",
        pager_duty_incident_configuration=ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyIncidentConfigurationProperty(
            service_id="serviceId"
        ),
        secret_id="secretId"
    )
)

Attributes

pager_duty_configuration

Information about the PagerDuty service where the response plan creates an incident.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html#cfn-ssmincidents-responseplan-integration-pagerdutyconfiguration

NotificationTargetItemProperty

class CfnResponsePlanPropsMixin.NotificationTargetItemProperty(*, sns_topic_arn=None)

Bases: object

The Amazon topic that’s used by to notify the incidents chat channel.

Parameters:: sns_topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon topic.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-notificationtargetitem.html
ExampleMetadata:: fixture=_generated

Example:

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

notification_target_item_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.NotificationTargetItemProperty(
    sns_topic_arn="snsTopicArn"
)

Attributes

sns_topic_arn

The Amazon Resource Name (ARN) of the Amazon topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-notificationtargetitem.html#cfn-ssmincidents-responseplan-notificationtargetitem-snstopicarn

PagerDutyConfigurationProperty

class CfnResponsePlanPropsMixin.PagerDutyConfigurationProperty(*, name=None, pager_duty_incident_configuration=None, secret_id=None)

Bases: object

Details about the PagerDuty configuration for a response plan.

Parameters:

name (Optional[str]) – The name of the PagerDuty configuration.
pager_duty_incident_configuration (Union[IResolvable, PagerDutyIncidentConfigurationProperty, Dict[str, Any], None]) – Details about the PagerDuty service associated with the configuration.
secret_id (Optional[str]) – The ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pager_duty_configuration_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyConfigurationProperty(
    name="name",
    pager_duty_incident_configuration=ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyIncidentConfigurationProperty(
        service_id="serviceId"
    ),
    secret_id="secretId"
)

Attributes

name

The name of the PagerDuty configuration.

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

pager_duty_incident_configuration

Details about the PagerDuty service associated with the configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyconfiguration-pagerdutyincidentconfiguration

secret_id

The ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyconfiguration-secretid

PagerDutyIncidentConfigurationProperty

class CfnResponsePlanPropsMixin.PagerDutyIncidentConfigurationProperty(*, service_id=None)

Bases: object

Details about the PagerDuty service where the response plan creates an incident.

Parameters:: service_id (Optional[str]) – The ID of the PagerDuty service that the response plan associates with an incident when it launches.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

pager_duty_incident_configuration_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.PagerDutyIncidentConfigurationProperty(
    service_id="serviceId"
)

Attributes

service_id

The ID of the PagerDuty service that the response plan associates with an incident when it launches.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html#cfn-ssmincidents-responseplan-pagerdutyincidentconfiguration-serviceid

SsmAutomationProperty

class CfnResponsePlanPropsMixin.SsmAutomationProperty(*, document_name=None, document_version=None, dynamic_parameters=None, parameters=None, role_arn=None, target_account=None)

Bases: object

The SsmAutomation property type specifies details about the Systems Manager Automation runbook that will be used as the runbook during an incident.

Parameters:

document_name (Optional[str]) – The automation document’s name.
document_version (Optional[str]) – The version of the runbook to use when running.
dynamic_parameters (Union[IResolvable, Sequence[Union[IResolvable, DynamicSsmParameterProperty, Dict[str, Any]]], None]) – The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters (Union[IResolvable, Sequence[Union[IResolvable, SsmParameterProperty, Dict[str, Any]]], None]) – The key-value pair parameters to use when running the runbook.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
target_account (Optional[str]) – The account that the automation document will be run in. This can be in either the management account or an application account.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

ssm_automation_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty(
    document_name="documentName",
    document_version="documentVersion",
    dynamic_parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterProperty(
        key="key",
        value=ssmincidents_mixins.CfnResponsePlanPropsMixin.DynamicSsmParameterValueProperty(
            variable="variable"
        )
    )],
    parameters=[ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmParameterProperty(
        key="key",
        values=["values"]
    )],
    role_arn="roleArn",
    target_account="targetAccount"
)

Attributes

document_name

The automation document’s name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentname

document_version

The version of the runbook to use when running.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-documentversion

dynamic_parameters

The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-dynamicparameters

parameters

The key-value pair parameters to use when running the runbook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-parameters

role_arn

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-rolearn

target_account

The account that the automation document will be run in.

This can be in either the management account or an application account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html#cfn-ssmincidents-responseplan-ssmautomation-targetaccount

SsmParameterProperty

class CfnResponsePlanPropsMixin.SsmParameterProperty(*, key=None, values=None)

Bases: object

The key-value pair parameters to use when running the Automation runbook.

Parameters:

key (Optional[str]) – The key parameter to use when running the Automation runbook.
values (Optional[Sequence[str]]) – The value parameter to use when running the Automation runbook.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

ssm_parameter_property = ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmParameterProperty(
    key="key",
    values=["values"]
)

Attributes

key

The key parameter to use when running the Automation runbook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html#cfn-ssmincidents-responseplan-ssmparameter-key

values

The value parameter to use when running the Automation runbook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html#cfn-ssmincidents-responseplan-ssmparameter-values