CfnContactProps

class aws_cdk.aws_ssmcontacts.CfnContactProps(*, alias, display_name, type, plan=None)

Bases: object

Properties for defining a CfnContact.

Parameters:
  • alias (str) – The unique and identifiable alias of the contact or escalation plan.

  • display_name (str) – The full name of the contact or escalation plan.

  • type (str) – Refers to the type of contact:. - PERSONAL : A single, individual contact. - ESCALATION : An escalation plan. - ONCALL_SCHEDULE : An on-call schedule.

  • plan (Union[IResolvable, Sequence[Union[StageProperty, Dict[str, Any], IResolvable]], None]) – A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.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_ssmcontacts as ssmcontacts

cfn_contact_props = ssmcontacts.CfnContactProps(
    alias="alias",
    display_name="displayName",
    type="type",

    # the properties below are optional
    plan=[ssmcontacts.CfnContact.StageProperty(
        duration_in_minutes=123,
        rotation_ids=["rotationIds"],
        targets=[ssmcontacts.CfnContact.TargetsProperty(
            channel_target_info=ssmcontacts.CfnContact.ChannelTargetInfoProperty(
                channel_id="channelId",
                retry_interval_in_minutes=123
            ),
            contact_target_info=ssmcontacts.CfnContact.ContactTargetInfoProperty(
                contact_id="contactId",
                is_essential=False
            )
        )]
    )]
)

Attributes

alias

The unique and identifiable alias of the contact or escalation plan.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-alias

display_name

The full name of the contact or escalation plan.

Link:

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

plan

A list of stages.

A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-plan

type

.

  • PERSONAL : A single, individual contact.

  • ESCALATION : An escalation plan.

  • ONCALL_SCHEDULE : An on-call schedule.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type

Type:

Refers to the type of contact