AWS::Pinpoint::BaiduChannel - 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::BaiduChannel

A channel is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application.

The BaiduChannel resource represents the status and authentication settings of the Baidu channel for an application.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Pinpoint::BaiduChannel",
  "Properties" : {
      "ApiKey" : String,
      "ApplicationId" : String,
      "Enabled" : Boolean,
      "SecretKey" : String
    }
}

YAML

Type: AWS::Pinpoint::BaiduChannel
Properties:
  ApiKey: String
  ApplicationId: String
  Enabled: Boolean
  SecretKey: String

Properties

ApiKey

The API key that you received from the Baidu Cloud Push service to communicate with the service.

Required: Yes

Type: String

Update requires: No interruption

ApplicationId

The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for.

Required: Yes

Type: String

Update requires: Replacement

Enabled

Specifies whether to enable the Baidu channel for the application.

Required: No

Type: Boolean

Update requires: No interruption

SecretKey

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

Required: Yes

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 Baidu channel. This property is retained only for backward compatibility.