Package software.amazon.awscdk.services.ssmcontacts

Class CfnContact

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ssmcontacts.CfnContact
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IContactRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:50.981Z") @Stability(Stable) public class CfnContact extends CfnResource implements IInspectable, IContactRef, ITaggableV2
The AWS::SSMContacts::Contact resource specifies a contact or escalation plan.

Incident Manager contacts are a subset of actions and data types that you can use for managing responder engagement and interaction.

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.*;
 CfnContact cfnContact = CfnContact.Builder.create(this, "MyCfnContact")
         .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()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnContact

      protected CfnContact(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnContact

      protected CfnContact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnContact

      @Stability(Stable) public CfnContact(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnContactProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Contact resource, such as arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getContactRef

      @Stability(Stable) @NotNull public ContactReference getContactRef()
      A reference to a Contact resource.
      Specified by:
      getContactRef in interface IContactRef

    • getAlias

      @Stability(Stable) @NotNull public String getAlias()
      The unique and identifiable alias of the contact or escalation plan.

    • setAlias

      @Stability(Stable) public void setAlias(@NotNull String value)
      The unique and identifiable alias of the contact or escalation plan.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The full name of the contact or escalation plan.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The full name of the contact or escalation plan.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of contact.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of contact.

    • getPlan

      @Stability(Stable) @Nullable public Object getPlan()
      A list of stages.

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

    • setPlan

      @Stability(Stable) public void setPlan(@Nullable IResolvable value)
      A list of stages.

    • setPlan

      @Stability(Stable) public void setPlan(@Nullable List<Object> value)
      A list of stages.

    • getTags

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

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)