Package software.amazon.awscdk.services.ssmcontacts

Class CfnContact

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ssmcontacts.CfnContact
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.816Z") @Stability(Stable) public class CfnContact extends CfnResource implements IInspectable
A CloudFormation AWS::SSMContacts::Contact.

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()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnContactProps props)
      Create a new AWS::SSMContacts::Contact.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 .

    • getCfnProperties

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

    • 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()
      Refers to the type of contact:.

      • PERSONAL : A single, individual contact.
      • ESCALATION : An escalation plan.
      • ONCALL_SCHEDULE : An on-call schedule.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      Refers to the type of contact:.

      • PERSONAL : A single, individual contact.
      • ESCALATION : An escalation plan.
      • ONCALL_SCHEDULE : An on-call schedule.

    • getPlan

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

    • setPlan

      @Stability(Stable) public void setPlan(@Nullable IResolvable value)
      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.

    • setPlan

      @Stability(Stable) public void setPlan(@Nullable List<Object> value)
      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.