CfnPlanPropsMixin

class aws_cdk.mixins_preview.aws_ssmcontacts.mixins.CfnPlanPropsMixin(props, *, strategy=None)

Bases: Mixin

Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.

Template example : We recommend creating all Incident Manager Contacts resources using a single AWS CloudFormation template. For a demonstration, see the examples for AWS::SSMContacts::Contacts .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html
CloudformationResource:: AWS::SSMContacts::Plan
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_ssmcontacts import mixins as ssmcontacts_mixins

cfn_plan_props_mixin = ssmcontacts_mixins.CfnPlanPropsMixin(ssmcontacts_mixins.CfnPlanMixinProps(
    contact_id="contactId",
    rotation_ids=["rotationIds"],
    stages=[ssmcontacts_mixins.CfnPlanPropsMixin.StageProperty(
        duration_in_minutes=123,
        targets=[ssmcontacts_mixins.CfnPlanPropsMixin.TargetsProperty(
            channel_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ChannelTargetInfoProperty(
                channel_id="channelId",
                retry_interval_in_minutes=123
            ),
            contact_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ContactTargetInfoProperty(
                contact_id="contactId",
                is_essential=False
            )
        )]
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSMContacts::Plan.

Parameters:

props (Union[CfnPlanMixinProps, 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 = ['contactId', 'rotationIds', 'stages']

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

ChannelTargetInfoProperty

class CfnPlanPropsMixin.ChannelTargetInfoProperty(*, channel_id=None, retry_interval_in_minutes=None)

Bases: object

Information about the contact channel that Incident Manager uses to engage the contact.

Parameters:

channel_id (Optional[str]) – The Amazon Resource Name (ARN) of the contact channel.
retry_interval_in_minutes (Union[int, float, None]) – The number of minutes to wait before retrying to send engagement if the engagement initially failed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.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_ssmcontacts import mixins as ssmcontacts_mixins

channel_target_info_property = ssmcontacts_mixins.CfnPlanPropsMixin.ChannelTargetInfoProperty(
    channel_id="channelId",
    retry_interval_in_minutes=123
)

Attributes

channel_id

The Amazon Resource Name (ARN) of the contact channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-channelid

retry_interval_in_minutes

The number of minutes to wait before retrying to send engagement if the engagement initially failed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes

ContactTargetInfoProperty

class CfnPlanPropsMixin.ContactTargetInfoProperty(*, contact_id=None, is_essential=None)

Bases: object

The contact that Incident Manager is engaging during an incident.

Parameters:

contact_id (Optional[str]) – The Amazon Resource Name (ARN) of the contact.
is_essential (Union[bool, IResolvable, None]) – A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.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_ssmcontacts import mixins as ssmcontacts_mixins

contact_target_info_property = ssmcontacts_mixins.CfnPlanPropsMixin.ContactTargetInfoProperty(
    contact_id="contactId",
    is_essential=False
)

Attributes

contact_id

The Amazon Resource Name (ARN) of the contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-contactid

is_essential

A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-isessential

StageProperty

class CfnPlanPropsMixin.StageProperty(*, duration_in_minutes=None, targets=None)

Bases: object

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

Parameters:

duration_in_minutes (Union[int, float, None]) – The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
targets (Union[IResolvable, Sequence[Union[IResolvable, TargetsProperty, Dict[str, Any]]], None]) – The contacts or contact methods that the escalation plan or engagement plan is engaging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.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_ssmcontacts import mixins as ssmcontacts_mixins

stage_property = ssmcontacts_mixins.CfnPlanPropsMixin.StageProperty(
    duration_in_minutes=123,
    targets=[ssmcontacts_mixins.CfnPlanPropsMixin.TargetsProperty(
        channel_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ChannelTargetInfoProperty(
            channel_id="channelId",
            retry_interval_in_minutes=123
        ),
        contact_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ContactTargetInfoProperty(
            contact_id="contactId",
            is_essential=False
        )
    )]
)

Attributes

duration_in_minutes

The time to wait until beginning the next stage.

The duration can only be set to 0 if a target is specified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-durationinminutes

targets

The contacts or contact methods that the escalation plan or engagement plan is engaging.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-targets

TargetsProperty

class CfnPlanPropsMixin.TargetsProperty(*, channel_target_info=None, contact_target_info=None)

Bases: object

The contact or contact channel that’s being engaged.

Parameters:

channel_target_info (Union[IResolvable, ChannelTargetInfoProperty, Dict[str, Any], None]) – Information about the contact channel that Incident Manager engages.
contact_target_info (Union[IResolvable, ContactTargetInfoProperty, Dict[str, Any], None]) – Information about the contact that Incident Manager engages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.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_ssmcontacts import mixins as ssmcontacts_mixins

targets_property = ssmcontacts_mixins.CfnPlanPropsMixin.TargetsProperty(
    channel_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ChannelTargetInfoProperty(
        channel_id="channelId",
        retry_interval_in_minutes=123
    ),
    contact_target_info=ssmcontacts_mixins.CfnPlanPropsMixin.ContactTargetInfoProperty(
        contact_id="contactId",
        is_essential=False
    )
)

Attributes

channel_target_info

Information about the contact channel that Incident Manager engages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-channeltargetinfo

contact_target_info

Information about the contact that Incident Manager engages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-contacttargetinfo