aws-cdk-lib.aws_ssmcontacts.CfnContactChannelProps

interface CfnContactChannelProps

LanguageType name
.NETAmazon.CDK.AWS.SSMContacts.CfnContactChannelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssmcontacts#CfnContactChannelProps
Javasoftware.amazon.awscdk.services.ssmcontacts.CfnContactChannelProps
Pythonaws_cdk.aws_ssmcontacts.CfnContactChannelProps
TypeScript aws-cdk-lib » aws_ssmcontacts » CfnContactChannelProps

Properties for defining a CfnContactChannel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssmcontacts as ssmcontacts } from 'aws-cdk-lib';
const cfnContactChannelProps: ssmcontacts.CfnContactChannelProps = {
  channelAddress: 'channelAddress',
  channelName: 'channelName',
  channelType: 'channelType',
  contactId: 'contactId',

  // the properties below are optional
  deferActivation: false,
};

Properties

NameTypeDescription
channelAddressstringThe details that Incident Manager uses when trying to engage the contact channel.
channelNamestringThe name of the contact channel.
channelTypestringThe type of the contact channel. Incident Manager supports three contact methods:.
contactIdstringThe Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
deferActivation?boolean | IResolvableIf you want to activate the channel at a later time, you can choose to defer activation.

channelAddress

Type: string

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


channelName

Type: string

The name of the contact channel.


channelType

Type: string

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

  • SMS
  • VOICE
  • EMAIL

contactId

Type: string

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


deferActivation?

Type: boolean | IResolvable (optional)

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.