interface CfnContactProps

Language	Type name
.NET	Amazon.CDK.AWS.SSMContacts.CfnContactProps
Java	software.amazon.awscdk.services.ssmcontacts.CfnContactProps
Python	aws_cdk.aws_ssmcontacts.CfnContactProps
TypeScript	@aws-cdk/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 * as ssmcontacts from '@aws-cdk/aws-ssmcontacts';
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

Name	Type	Description
alias	string	The unique and identifiable alias of the contact or escalation plan.
displayName	string	The full name of the contact or escalation plan.
type	string	Refers to the type of contact:.
plan?	IResolvable | StageProperty | IResolvable[]	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 | StageProperty | IResolvable[] (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.