Class CfnGCMChannel

A channel is a type of platform that you can deliver messages to.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnGCMChannel

Implements

IInspectable

IGCMChannelRef

IConstruct

IDependable

IEnvironmentAware

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.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGCMChannel : CfnResource, IInspectable, IGCMChannelRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnGCMChannel Inherits CfnResource Implements IInspectable, IGCMChannelRef, IConstruct, IDependable, IEnvironmentAware

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

Create a new AWS::Pinpoint::GCMChannel.

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	A channel is a type of platform that you can deliver messages to.
CfnPropertyNames	A channel is a type of platform that you can deliver messages to.
DefaultAuthenticationMethod	The default authentication method used for GCM.
Enabled	Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
GcmChannelRef	A reference to a GCMChannel resource.
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.
IsCfnGCMChannel(object)	Checks whether the given object is a CfnGCMChannel.
RenderProperties(IDictionary<string, object>)	A channel is a type of platform that you can deliver messages to.

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 string: Construct identifier for this resource (unique in its scope).
props ICfnGCMChannelProps: Resource properties.

Remarks

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

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

string

Remarks

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

ApplicationId

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

public virtual string ApplicationId { get; set; }

Property Value

string

Remarks

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

AttrId

(Deprecated) An identifier for the GCM channel.

public virtual string AttrId { get; }

Property Value

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

string

Remarks

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

CfnProperties

A channel is a type of platform that you can deliver messages to.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CfnPropertyNames

A channel is a type of platform that you can deliver messages to.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

DefaultAuthenticationMethod

The default authentication method used for GCM.

public virtual string? DefaultAuthenticationMethod { get; set; }

Property Value

string

Remarks

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

Enabled

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

public virtual object? Enabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

GcmChannelRef

A reference to a GCMChannel resource.

public virtual IGCMChannelReference GcmChannelRef { get; }

Property Value

IGCMChannelReference

Remarks

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

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

string

Remarks

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

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

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

IsCfnGCMChannel(object)

Checks whether the given object is a CfnGCMChannel.

public static bool IsCfnGCMChannel(object x)

Parameters

x object

Returns

bool

Remarks

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

RenderProperties(IDictionary<string, object>)

A channel is a type of platform that you can deliver messages to.

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

Remarks

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

Implements

IInspectable

IGCMChannelRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware