interface CfnContactProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SSMContacts.CfnContactProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsssmcontacts#CfnContactProps |
![]() | software.amazon.awscdk.services.ssmcontacts.CfnContactProps |
![]() | aws_cdk.aws_ssmcontacts.CfnContactProps |
![]() | 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,
},
}],
}],
};
Properties
Name | Type | Description |
---|---|---|
alias | string | The unique and identifiable alias of the contact or escalation plan. |
display | string | The full name of the contact or escalation plan. |
type | string | The type of contact. |
plan? | IResolvable | IResolvable | Stage [] | 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
The type of contact.
PERSONAL
: A single, individual contact.ESCALATION
: An escalation plan.ONCALL_SCHEDULE
: An on-call schedule.
plan?
Type:
IResolvable
|
IResolvable
|
Stage
[]
(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.