Class CfnGCMChannel
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 CfnGCMChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnGCMChannel
Inherits CfnResource
Implements IInspectable
Remarks
You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaced the Google Cloud Messaging (GCM) service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application.
The GCMChannel resource represents the status and authentication settings of the GCM channel for an application.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
CloudformationResource: AWS::Pinpoint::GCMChannel
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 cfnGCMChannel = new CfnGCMChannel(this, "MyCfnGCMChannel", new CfnGCMChannelProps {
ApplicationId = "applicationId",
// the properties below are optional
ApiKey = "apiKey",
DefaultAuthenticationMethod = "defaultAuthenticationMethod",
Enabled = false,
ServiceJson = "serviceJson"
});
Synopsis
Constructors
CfnGCMChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGCMChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGCMChannel(Construct, String, ICfnGCMChannelProps) |
Properties
ApiKey | The Web API key, also called the server key , that you received from Google to communicate with Google services. |
ApplicationId | The unique identifier for the Amazon Pinpoint application that the GCM channel applies to. |
AttrId | (Deprecated) An identifier for the GCM channel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DefaultAuthenticationMethod | The default authentication method used for GCM. |
Enabled | Specifies whether to enable the GCM channel for the Amazon Pinpoint application. |
ServiceJson | The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGCMChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGCMChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGCMChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGCMChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGCMChannel(Construct, String, ICfnGCMChannelProps)
public CfnGCMChannel(Construct scope, string id, ICfnGCMChannelProps 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 ICfnGCMChannelProps
Resource properties.
Properties
ApiKey
The Web API key, also called the server key , that you received from Google to communicate with Google services.
public virtual string ApiKey { get; set; }
Property Value
System.String
ApplicationId
The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrId
(Deprecated) An identifier for the GCM 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
DefaultAuthenticationMethod
The default authentication method used for GCM.
public virtual string DefaultAuthenticationMethod { get; set; }
Property Value
System.String
Enabled
Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
public virtual object Enabled { get; set; }
Property Value
System.Object
ServiceJson
The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.
public virtual string ServiceJson { get; set; }
Property Value
System.String
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>