Class CfnADMChannel
A channel is a type of platform that you can deliver messages to.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnADMChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnADMChannel
Inherits CfnResource
Implements IInspectable
Remarks
You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application.
The ADMChannel resource represents the status and authentication settings for the ADM channel for an application.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
CloudformationResource: AWS::Pinpoint::ADMChannel
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;
var cfnADMChannel = new CfnADMChannel(this, "MyCfnADMChannel", new CfnADMChannelProps {
ApplicationId = "applicationId",
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
Enabled = false
});
Synopsis
Constructors
CfnADMChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnADMChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnADMChannel(Construct, String, ICfnADMChannelProps) |
Properties
ApplicationId | The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. |
AttrId | (Deprecated) An identifier for the ADM channel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientId | The Client ID that you received from Amazon to send messages by using ADM. |
ClientSecret | The Client Secret that you received from Amazon to send messages by using ADM. |
Enabled | Specifies whether to enable the ADM channel for the application. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnADMChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnADMChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnADMChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnADMChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnADMChannel(Construct, String, ICfnADMChannelProps)
public CfnADMChannel(Construct scope, string id, ICfnADMChannelProps 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 ICfnADMChannelProps
Resource properties.
Properties
ApplicationId
The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrId
(Deprecated) An identifier for the ADM channel.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
This property is retained only for backward compatibility.
CloudformationAttribute: Id
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
ClientId
The Client ID that you received from Amazon to send messages by using ADM.
public virtual string ClientId { get; set; }
Property Value
System.String
ClientSecret
The Client Secret that you received from Amazon to send messages by using ADM.
public virtual string ClientSecret { get; set; }
Property Value
System.String
Enabled
Specifies whether to enable the ADM channel for the application.
public virtual object Enabled { 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>