Class CfnContactChannel

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnContactChannel

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

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(Construct, string, ICfnContactChannelProps)

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

Properties

AttrArn	The Amazon Resource Name (ARN) of the ContactChannel resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::SSMContacts::ContactChannel resource specifies a contact channel as the method that Incident Manager uses to engage your contact.
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>)	The AWS::SSMContacts::ContactChannel resource specifies a contact channel as the method that Incident Manager uses to engage your contact.

Constructors

CfnContactChannel(Construct, string, ICfnContactChannelProps)

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

public CfnContactChannel(Construct scope, string id, ICfnContactChannelProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnContactChannelProps

Resource properties.

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

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

string

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

ChannelAddress

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

public virtual string ChannelAddress { get; set; }

Property Value

string

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

ChannelName

The name of the contact channel.

public virtual string ChannelName { get; set; }

Property Value

string

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

ChannelType

The type of the contact channel.

public virtual string ChannelType { get; set; }

Property Value

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

string

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

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

object

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

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.

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

<em>Template example</em> : We recommend creating all Incident Manager <code>Contacts</code> resources using a single AWS CloudFormation template. For a demonstration, see the examples for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html">AWS::SSMContacts::Contacts</a> .

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

CloudformationResource: AWS::SSMContacts::ContactChannel

ExampleMetadata: fixture=_generated

Implements

IInspectable