Class CfnGCMChannel

A CloudFormation AWS::Pinpoint::GCMChannel.

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

A channel is a type of platform that you can deliver messages to. 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.

CloudformationResource: AWS::Pinpoint::GCMChannel

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.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;

var cfnGCMChannel = new CfnGCMChannel(this, "MyCfnGCMChannel", new CfnGCMChannelProps {
    ApiKey = "apiKey",
    ApplicationId = "applicationId",

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

Synopsis

Constructors

CfnGCMChannel(Construct, String, ICfnGCMChannelProps)

Create a new AWS::Pinpoint::GCMChannel.
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

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.
CFN_RESOURCE_TYPE_NAME

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

Specifies whether to enable the GCM channel for the Amazon Pinpoint application.

Methods

Inspect(TreeInspector)

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

Constructors

CfnGCMChannel(Construct, String, ICfnGCMChannelProps)

Create a new AWS::Pinpoint::GCMChannel.

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

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

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

Remarks

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

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

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-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 GCM channel for the Amazon Pinpoint application.

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

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-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