aws-cdk-lib.aws_ssmcontacts.CfnContactProps

interface CfnContactProps

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

Properties for defining a CfnContact.

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 cfnContactProps: ssmcontacts.CfnContactProps = {
  alias: 'alias',
  displayName: 'displayName',
  type: 'type',

  // the properties below are optional
  plan: [{
    durationInMinutes: 123,
    rotationIds: ['rotationIds'],
    targets: [{
      channelTargetInfo: {
        channelId: 'channelId',
        retryIntervalInMinutes: 123,
      },
      contactTargetInfo: {
        contactId: 'contactId',
        isEssential: false,
      },
    }],
  }],
};

Properties

NameTypeDescription
aliasstringThe unique and identifiable alias of the contact or escalation plan.
displayNamestringThe full name of the contact or escalation plan.
typestringRefers to the type of contact:.
plan?IResolvable | IResolvable | StageProperty[]A list of stages.

alias

Type: string

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


displayName

Type: string

The full name of the contact or escalation plan.


type

Type: string

Refers to the type of contact:.

  • PERSONAL : A single, individual contact.
  • ESCALATION : An escalation plan.
  • ONCALL_SCHEDULE : An on-call schedule.

plan?

Type: IResolvable | IResolvable | StageProperty[] (optional)

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.