AWS::Pinpoint::GCMChannel
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Pinpoint::GCMChannel", "Properties" : { "ApiKey" :
String
, "ApplicationId" :String
, "Enabled" :Boolean
} }
YAML
Type: AWS::Pinpoint::GCMChannel Properties: ApiKey:
String
ApplicationId:String
Enabled:Boolean
Properties
ApiKey
-
The Web API key, also called the server key, that you received from Google to communicate with Google services.
Required: Yes
Type: String
Update requires: No interruption
ApplicationId
-
The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
Required: Yes
Type: String
Update requires: Replacement
Enabled
-
Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
Required: No
Type: Boolean
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the unique identifier (ApplicationId
) for
the Amazon Pinpoint application that the channel is associated with.
For more information about using the Ref
function, see Ref.