AWS::Pinpoint::GCMChannel - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

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 Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Pinpoint::GCMChannel",
  "Properties" : {
      "ApiKey" : String,
      "ApplicationId" : String,
      "DefaultAuthenticationMethod" : String,
      "Enabled" : Boolean,
      "ServiceJson" : String
    }
}

YAML

Type: AWS::Pinpoint::GCMChannel
Properties:
  ApiKey: String
  ApplicationId: String
  DefaultAuthenticationMethod: String
  Enabled: Boolean
  ServiceJson: String

Properties

ApiKey

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

Required: No

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

DefaultAuthenticationMethod

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

Required: No

Type: String

Update requires: No interruption

Enabled

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

Required: No

Type: Boolean

Update requires: No interruption

ServiceJson

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.

Required: No

Type: String

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.

Fn::GetAtt

Id

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.