Class CfnContactChannel
The AWS::SSMContacts::ContactChannel
resource specifies a contact channel as the method that Incident Manager uses to engage your contact.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SSMContacts
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContactChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnContactChannel
Inherits CfnResource
Implements IInspectable
Remarks
Template example : We recommend creating all Incident Manager Contacts
resources using a single AWS CloudFormation template. For a demonstration, see the examples for AWS::SSMContacts::Contacts .
CloudformationResource: AWS::SSMContacts::ContactChannel
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSMContacts;
var cfnContactChannel = new CfnContactChannel(this, "MyCfnContactChannel", new CfnContactChannelProps {
ChannelAddress = "channelAddress",
ChannelName = "channelName",
ChannelType = "channelType",
ContactId = "contactId",
// the properties below are optional
DeferActivation = false
});
Synopsis
Constructors
CfnContactChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnContactChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnContactChannel(Construct, String, ICfnContactChannelProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ChannelAddress | The details that Incident Manager uses when trying to engage the contact channel. |
ChannelName | The name of the contact channel. |
ChannelType | The type of the contact channel. |
ContactId | The Amazon Resource Name (ARN) of the contact you are adding the contact channel to. |
DeferActivation | If you want to activate the channel at a later time, you can choose to defer activation. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnContactChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnContactChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnContactChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnContactChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnContactChannel(Construct, String, ICfnContactChannelProps)
public CfnContactChannel(Construct scope, string id, ICfnContactChannelProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnContactChannelProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the ContactChannel
resource.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ChannelAddress
The details that Incident Manager uses when trying to engage the contact channel.
public virtual string ChannelAddress { get; set; }
Property Value
System.String
ChannelName
The name of the contact channel.
public virtual string ChannelName { get; set; }
Property Value
System.String
ChannelType
The type of the contact channel.
public virtual string ChannelType { get; set; }
Property Value
System.String
Remarks
Incident Manager supports three contact methods:.
ContactId
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
public virtual string ContactId { get; set; }
Property Value
System.String
DeferActivation
If you want to activate the channel at a later time, you can choose to defer activation.
public virtual object DeferActivation { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>