AWS Amazon Pinpoint GCM Channel

This page shows how to write Terraform and CloudFormation for Amazon Pinpoint GCM Channel and write them securely.

aws_pinpoint_gcm_channel (Terraform)

The GCM Channel in Amazon Pinpoint can be configured in Terraform with the resource name aws_pinpoint_gcm_channel. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Explanation in Terraform Registry

Provides a Pinpoint GCM Channel resource.

Note: Api Key argument will be stored in the raw state as plain-text. Read more about sensitive data in state.

AWS::Pinpoint::GCMChannel (CloudFormation)

The GCMChannel in Pinpoint can be configured in CloudFormation with the resource name AWS::Pinpoint::GCMChannel. The following sections describe 9 examples of how to use the resource and its parameters.

Example Usage from GitHub

product.template-us-east-1.yaml#L12
    Type: AWS::Pinpoint::GCMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
    Properties:
      ApiKey: !Ref 'ApiKey'
      ApplicationId: !Ref 'ApplicationId'
aws-pinpoint-gcmchannel.yaml#L12
    Type: AWS::Pinpoint::GCMChannel
    Properties:
      ApplicationId: !Ref applicationid
      ApiKey: !Ref apikey
product.template-ap-south-1.yaml#L12
    Type: AWS::Pinpoint::GCMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
    Properties:
      ApiKey: !Ref 'ApiKey'
      ApplicationId: !Ref 'ApplicationId'
product.template-us-west-2.yaml#L12
    Type: AWS::Pinpoint::GCMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
    Properties:
      ApiKey: !Ref 'ApiKey'
      ApplicationId: !Ref 'ApplicationId'
product.template-ap-southeast-2.yaml#L12
    Type: AWS::Pinpoint::GCMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
    Properties:
      ApiKey: !Ref 'ApiKey'
      ApplicationId: !Ref 'ApplicationId'
awsResouceIconMatches.json#L588
        "resourceType": "AWS::Pinpoint::GCMChannel",
        "filePath": "icons/aws/Service/Arch_Mobile/64/Arch_Amazon-Pinpoint_64@5x.png"
      },
      {
        "resourceType": "AWS::Pinpoint::APNSChannel",
        "filePath": null
PinpointGCMChannelSpecification.json#L3
    "AWS::Pinpoint::GCMChannel": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html",
      "Properties": {
        "ApiKey": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-apikey",
backend-details.json#L160
            "type": "AWS::Pinpoint::GCMChannel",
            "name": null,
            "arn": null,
            "feature": "analytics",
            "attributes": {
                "AppID": "e80e7788d1f04a0ab1fbf51bb0804e92",
template.json#L1255
    "AWS::Pinpoint::GCMChannel": {
      "Type": "AWS::Pinpoint::GCMChannel",
      "Properties": {}
    },
    "AWS::GuardDuty::Detector": {
      "Type": "AWS::GuardDuty::Detector",

Parameters

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

Explanation in CloudFormation Registry

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.

Frequently asked questions

What is AWS Amazon Pinpoint GCM Channel?

AWS Amazon Pinpoint GCM Channel is a resource for Amazon Pinpoint of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Amazon Pinpoint GCM Channel?

For CloudFormation, the awslabs/aws-service-catalog-products, rubyonrails3/cfn-rules and awslabs/aws-service-catalog-products source code examples are useful. See the CloudFormation Example section for further details.