Package software.amazon.awscdk.services.ssmcontacts

Interface CfnContactChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContactChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.279Z")
@Stability(Stable)
public interface CfnContactChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnContactChannel.

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.*;
 CfnContactChannelProps cfnContactChannelProps = CfnContactChannelProps.builder()
         .channelAddress("channelAddress")
         .channelName("channelName")
         .channelType("channelType")
         .contactId("contactId")
         // the properties below are optional
         .deferActivation(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContactChannelProps.Builder	builder()
String	getChannelAddress()	The details that Incident Manager uses when trying to engage the contact channel.
String	getChannelName()	The name of the contact channel.
String	getChannelType()	The type of the contact channel.
String	getContactId()	The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
default Object	getDeferActivation()	If you want to activate the channel at a later time, you can choose to defer activation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelAddress

@Stability(Stable)
@NotNull
String getChannelAddress()

The details that Incident Manager uses when trying to engage the contact channel.

See Also:

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

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

The name of the contact channel.

See Also:

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

getChannelType

@Stability(Stable)
@NotNull
String getChannelType()

The type of the contact channel. Incident Manager supports three contact methods:.

• SMS
• VOICE
• EMAIL

See Also:

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

getContactId

@Stability(Stable)
@NotNull
String getContactId()

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

See Also:

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

getDeferActivation

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

See Also:

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

builder

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

Returns:

a CfnContactChannelProps.Builder of CfnContactChannelProps