CfnContactChannelProps

class aws_cdk.aws_ssmcontacts.CfnContactChannelProps(*, channel_address, channel_name, channel_type, contact_id, defer_activation=None)

Bases: object

Properties for defining a CfnContactChannel.

Parameters:
  • channel_address (str) – The details that Incident Manager uses when trying to engage the contact channel.

  • channel_name (str) – The name of the contact channel.

  • channel_type (str) – The type of the contact channel. Incident Manager supports three contact methods:. - SMS - VOICE - EMAIL

  • contact_id (str) – The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

  • defer_activation (Union[bool, IResolvable, None]) – If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can’t engage your contact channel until it has been activated.

See:

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

cfn_contact_channel_props = ssmcontacts.CfnContactChannelProps(
    channel_address="channelAddress",
    channel_name="channelName",
    channel_type="channelType",
    contact_id="contactId",

    # the properties below are optional
    defer_activation=False
)

Attributes

channel_address

The details that Incident Manager uses when trying to engage the contact channel.

See:

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

channel_name

The name of the contact channel.

See:

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

channel_type

.

  • SMS

  • VOICE

  • EMAIL

See:

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

Type:

The type of the contact channel. Incident Manager supports three contact methods

contact_id

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

See:

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

defer_activation

If you want to activate the channel at a later time, you can choose to defer activation.

Incident Manager can’t engage your contact channel until it has been activated.

See:

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