AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::GCMChannel

CfnGCMChannel

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.

Import

import { CfnGCMChannel } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnGCMChannel

Properties

Configuration passed to the constructor as CfnGCMChannelProps.

applicationIdRequired
string

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

apiKeyOptional
string

The Web API key, also called the *server key* , that you received from Google to communicate with Google services.

defaultAuthenticationMethodOptional
string

The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".

enabledOptional
boolean | IResolvable

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

serviceJsonOptional
string

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see [Migrate from legacy FCM APIs to HTTP v1](https://docs.aws.amazon.com/https://firebase.google.com/docs/cloud-messaging/migrate-v1) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pinpoint::GCMChannelView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pinpoint
CFN TypeAWS::Pinpoint::GCMChannel
Properties5

Related Constructs

Explore This Service

External Links