software.amazon.awscdk.services.ssmcontacts

Class CfnContactChannel

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.CfnContactChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.337Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContactChannel.Builder A fluent builder for CfnContactChannel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnContactChannel(software.constructs.Construct scope, String id, CfnContactChannelProps props) Create a new `AWS::SSMContacts::ContactChannel`.
protected	CfnContactChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContactChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the `ContactChannel` resource.
protected Map<String,Object>	getCfnProperties()
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.
Object	getDeferActivation() If you want to activate the channel at a later time, you can choose to defer activation.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setChannelAddress(String value) The details that Incident Manager uses when trying to engage the contact channel.
void	setChannelName(String value) The name of the contact channel.
void	setChannelType(String value) The type of the contact channel.
void	setContactId(String value) The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
void	setDeferActivation(Boolean value) If you want to activate the channel at a later time, you can choose to defer activation.
void	setDeferActivation(IResolvable value) If you want to activate the channel at a later time, you can choose to defer activation.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnContactChannel

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

CfnContactChannel

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

CfnContactChannel

@Stability(value=Stable)
public CfnContactChannel(@NotNull
                                                  software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the `ContactChannel` resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getChannelAddress

@Stability(value=Stable)
 @NotNull
public String getChannelAddress()

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

setChannelAddress

@Stability(value=Stable)
public void setChannelAddress(@NotNull
                                                       String value)

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

getChannelName

@Stability(value=Stable)
 @NotNull
public String getChannelName()

The name of the contact channel.

setChannelName

@Stability(value=Stable)
public void setChannelName(@NotNull
                                                    String value)

The name of the contact channel.

getChannelType

@Stability(value=Stable)
 @NotNull
public String getChannelType()

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

• SMS
• VOICE
• EMAIL

setChannelType

@Stability(value=Stable)
public void setChannelType(@NotNull
                                                    String value)

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

• SMS
• VOICE
• EMAIL

getContactId

@Stability(value=Stable)
 @NotNull
public String getContactId()

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

setContactId

@Stability(value=Stable)
public void setContactId(@NotNull
                                                  String value)

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

getDeferActivation

@Stability(value=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(value=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(value=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.