Package software.amazon.awscdk.services.ssmcontacts

Interface CfnContactProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContactProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:24.157Z")
@Stability(Stable)
public interface CfnContactProps
extends software.amazon.jsii.JsiiSerializable

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)
                 .rotationIds(List.of("rotationIds"))
                 .targets(List.of(TargetsProperty.builder()
                         .channelTargetInfo(ChannelTargetInfoProperty.builder()
                                 .channelId("channelId")
                                 .retryIntervalInMinutes(123)
                                 .build())
                         .contactTargetInfo(ContactTargetInfoProperty.builder()
                                 .contactId("contactId")
                                 .isEssential(false)
                                 .build())
                         .build()))
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

@Stability(Stable)
@NotNull
String getAlias()

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

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

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

getType

@Stability(Stable)
@NotNull
String getType()

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

getPlan

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

@Stability(Stable)
static CfnContactProps.Builder builder()

Returns:

a CfnContactProps.Builder of CfnContactProps