software.amazon.awscdk.services.ssmcontacts

Interface CfnContactProps

All Known Implementing Classes:

CfnContactProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:19.352Z")
public interface 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 software.amazon.awscdk.services.ssmcontacts.*;
 CfnContactProps cfnContactProps = CfnContactProps.builder()
         .alias("alias")
         .displayName("displayName")
         .type("type")
         // the properties below are optional
         .plan(List.of(StageProperty.builder()
                 .durationInMinutes(123)
                 // the properties below are optional
                 .targets(List.of(TargetsProperty.builder()
                         .channelTargetInfo(ChannelTargetInfoProperty.builder()
                                 .channelId("channelId")
                                 .retryIntervalInMinutes(123)
                                 .build())
                         .contactTargetInfo(ContactTargetInfoProperty.builder()
                                 .contactId("contactId")
                                 .isEssential(false)
                                 .build())
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnContactProps.Builder A builder for CfnContactProps
static class	CfnContactProps.Jsii$Proxy An implementation for CfnContactProps

Method Summary

Modifier and Type	Method and Description
static CfnContactProps.Builder	builder()
java.lang.String	getAlias() The unique and identifiable alias of the contact or escalation plan.
java.lang.String	getDisplayName() The full name of the contact or escalation plan.
default java.lang.Object	getPlan() A list of stages.
java.lang.String	getType() Refers to the type of contact.

Method Detail

getAlias

java.lang.String getAlias()

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

getDisplayName

java.lang.String getDisplayName()

The full name of the contact or escalation plan.

getType

java.lang.String getType()

Refers to the type of contact.

A single contact is type PERSONAL and an escalation plan is type ESCALATION .

getPlan

default java.lang.Object getPlan()

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.

builder

static CfnContactProps.Builder builder()

Returns:

a CfnContactProps.Builder of CfnContactProps