Package software.amazon.awscdk.cfnpropertymixins.services.ssmcontacts

Interface CfnContactMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContactMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:34.478Z")
@Stability(Stable)
public interface CfnContactMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnContactPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssmcontacts.*;
 CfnContactMixinProps cfnContactMixinProps = CfnContactMixinProps.builder()
         .alias("alias")
         .displayName("displayName")
         .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()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .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	CfnContactMixinProps.Builder	A builder for CfnContactMixinProps
static final class	CfnContactMixinProps.Jsii$Proxy	An implementation for CfnContactMixinProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlias

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

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContactPropsMixin.StageProperty>

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

See Also:

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

getType

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

builder

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

Returns:

a CfnContactMixinProps.Builder of CfnContactMixinProps