Package software.amazon.awscdk.services.ssmcontacts

Class CfnContactChannel

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.CfnContactChannel
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.818Z") @Stability(Stable) public class CfnContactChannel extends CfnResource implements IInspectable
A CloudFormation AWS::SSMContacts::ContactChannel.

The AWS::SSMContacts::ContactChannel resource specifies a contact channel as the method that Incident Manager uses to engage your contact.

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.*;
 CfnContactChannel cfnContactChannel = CfnContactChannel.Builder.create(this, "MyCfnContactChannel")
         .channelAddress("channelAddress")
         .channelName("channelName")
         .channelType("channelType")
         .contactId("contactId")
         // the properties below are optional
         .deferActivation(false)
         .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

    • CfnContactChannel

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

    • CfnContactChannel

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

    • CfnContactChannel

      @Stability(Stable) public CfnContactChannel(@NotNull Construct scope, @NotNull String id, @NotNull CfnContactChannelProps props)
      Create a new AWS::SSMContacts::ContactChannel.

      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 ContactChannel resource.

    • getCfnProperties

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

    • getChannelAddress

      @Stability(Stable) @NotNull public String getChannelAddress()
      The details that Incident Manager uses when trying to engage the contact channel.

    • setChannelAddress

      @Stability(Stable) public void setChannelAddress(@NotNull String value)
      The details that Incident Manager uses when trying to engage the contact channel.

    • getChannelName

      @Stability(Stable) @NotNull public String getChannelName()
      The name of the contact channel.

    • setChannelName

      @Stability(Stable) public void setChannelName(@NotNull String value)
      The name of the contact channel.

    • getChannelType

      @Stability(Stable) @NotNull public String getChannelType()
      The type of the contact channel. Incident Manager supports three contact methods:.

      • SMS
      • VOICE
      • EMAIL

    • setChannelType

      @Stability(Stable) public void setChannelType(@NotNull String value)
      The type of the contact channel. Incident Manager supports three contact methods:.

      • SMS
      • VOICE
      • EMAIL

    • getContactId

      @Stability(Stable) @NotNull public String getContactId()
      The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

    • setContactId

      @Stability(Stable) public void setContactId(@NotNull String value)
      The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

    • getDeferActivation

      @Stability(Stable) @Nullable public Object getDeferActivation()
      If you want to activate the channel at a later time, you can choose to defer activation.

      Incident Manager can't engage your contact channel until it has been activated.

    • setDeferActivation

      @Stability(Stable) public void setDeferActivation(@Nullable Boolean value)
      If you want to activate the channel at a later time, you can choose to defer activation.

      Incident Manager can't engage your contact channel until it has been activated.

    • setDeferActivation

      @Stability(Stable) public void setDeferActivation(@Nullable IResolvable value)
      If you want to activate the channel at a later time, you can choose to defer activation.

      Incident Manager can't engage your contact channel until it has been activated.