interface CfnContactProps

Language	Type name
.NET	Amazon.CDK.AWS.SSMContacts.CfnContactProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsssmcontacts#CfnContactProps
Java	software.amazon.awscdk.services.ssmcontacts.CfnContactProps
Python	aws_cdk.aws_ssmcontacts.CfnContactProps
TypeScript	aws-cdk-lib » aws_ssmcontacts » CfnContactProps

Properties for defining a CfnContact.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html

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,
      },
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

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	The type of contact.
plan?	IResolvable | (IResolvable | StageProperty)[]	A list of stages.
tags?	CfnTag[]

---

alias

Type: string

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

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

---

displayName

Type: string

The full name of the contact or escalation plan.

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

---

type

Type: string

The type of contact.

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

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

---

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.

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

---

tags?

Type: CfnTag[] (optional)

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