Class CfnVoiceChannel

A CloudFormation AWS::Pinpoint::VoiceChannel.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnVoiceChannel
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public class CfnVoiceChannel : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnVoiceChannel
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

A channel is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.

The VoiceChannel resource represents the status and other information about the voice channel for an application.

CloudformationResource: AWS::Pinpoint::VoiceChannel

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html

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.Pinpoint;

CfnVoiceChannel cfnVoiceChannel = new CfnVoiceChannel(this, "MyCfnVoiceChannel", new CfnVoiceChannelProps {
    ApplicationId = "applicationId",

    // the properties below are optional
    Enabled = false
});

Synopsis

Constructors

CfnVoiceChannel(Construct, String, ICfnVoiceChannelProps)

Create a new AWS::Pinpoint::VoiceChannel.
CfnVoiceChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnVoiceChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that the voice channel applies to.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Enabled

Specifies whether to enable the voice channel for the application.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnVoiceChannel(Construct, String, ICfnVoiceChannelProps)

Create a new AWS::Pinpoint::VoiceChannel.

public CfnVoiceChannel(Construct scope, string id, ICfnVoiceChannelProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnVoiceChannelProps
  • resource properties.

CfnVoiceChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnVoiceChannel(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnVoiceChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnVoiceChannel(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that the voice channel applies to.

public virtual string ApplicationId { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-applicationid

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

Enabled

Specifies whether to enable the voice channel for the application.

public virtual object Enabled { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-enabled

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>

Overrides

Implements

Constructs.IConstruct