AWS Amazon Pinpoint ADM Channel

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

aws_pinpoint_adm_channel (Terraform)

The ADM Channel in Amazon Pinpoint can be configured in Terraform with the resource name aws_pinpoint_adm_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 ADM (Amazon Device Messaging) Channel resource.

Note: All arguments including the Client ID and Client Secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

AWS::Pinpoint::ADMChannel (CloudFormation)

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

Example Usage from GitHub

product.template-ap-southeast-2.yaml#L15
    Type: AWS::Pinpoint::ADMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
    Properties:
      ClientSecret: !Ref 'ClientSecret'
      ClientId: !Ref 'ClientId'
      ApplicationId: !Ref 'ApplicationId'
product.template-eu-west-1.yaml#L15
    Type: AWS::Pinpoint::ADMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
    Properties:
      ClientSecret: !Ref 'ClientSecret'
      ClientId: !Ref 'ClientId'
      ApplicationId: !Ref 'ApplicationId'
aws-pinpoint-admchannel.yaml#L15
    Type: AWS::Pinpoint::ADMChannel
    Properties:
      ApplicationId: !Ref applicationid
      ClientId: !Ref clientid
      ClientSecret: !Ref clientsecret
product.template-us-east-1.yaml#L15
    Type: AWS::Pinpoint::ADMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
    Properties:
      ClientSecret: !Ref 'ClientSecret'
      ClientId: !Ref 'ClientId'
      ApplicationId: !Ref 'ApplicationId'
product.template-us-west-2.yaml#L15
    Type: AWS::Pinpoint::ADMChannel
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
    Properties:
      ClientSecret: !Ref 'ClientSecret'
      ClientId: !Ref 'ClientId'
      ApplicationId: !Ref 'ApplicationId'
awsResouceIconMatches.json#L608
        "resourceType": "AWS::Pinpoint::ADMChannel",
        "filePath": null
      },
      {
        "resourceType": "AWS::Pinpoint::ApplicationSettings",
        "filePath": null
PinpointADMChannelSpecification.json#L3
    "AWS::Pinpoint::ADMChannel": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html",
      "Properties": {
        "ClientSecret": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientsecret",
template.json#L1859
    "AWS::Pinpoint::ADMChannel": {
      "Type": "AWS::Pinpoint::ADMChannel",
      "Properties": {}
    },
    "AWS::CertificateManager::Certificate": {
      "Type": "AWS::CertificateManager::Certificate",

Parameters

ApplicationId The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.
Required: Yes
Type: String
Update requires: Replacement

ClientId The Client ID that you received from Amazon to send messages by using ADM.
Required: Yes
Type: String
Update requires: No interruption

ClientSecret The Client Secret that you received from Amazon to send messages by using ADM.
Required: Yes
Type: String
Update requires: No interruption

Enabled Specifies whether to enable the ADM channel for the 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 ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application.

The ADMChannel resource represents the status and authentication settings for the ADM channel for an application.

Frequently asked questions

What is AWS Amazon Pinpoint ADM Channel?

AWS Amazon Pinpoint ADM 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 ADM Channel?

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