AWS::Pinpoint::APNSSandboxChannel
A channel is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application.
The APNSSandboxChannel resource represents the status and authentication settings of the APNs sandbox channel for an application.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Pinpoint::APNSSandboxChannel", "Properties" : { "ApplicationId" :
String
, "BundleId" :String
, "Certificate" :String
, "DefaultAuthenticationMethod" :String
, "Enabled" :Boolean
, "PrivateKey" :String
, "TeamId" :String
, "TokenKey" :String
, "TokenKeyId" :String
} }
YAML
Type: AWS::Pinpoint::APNSSandboxChannel Properties: ApplicationId:
String
BundleId:String
Certificate:String
DefaultAuthenticationMethod:String
Enabled:Boolean
PrivateKey:String
TeamId:String
TokenKey:String
TokenKeyId:String
Properties
ApplicationId
-
The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to.
Required: Yes
Type: String
Update requires: Replacement
BundleId
-
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
Required: No
Type: String
Update requires: No interruption
Certificate
-
The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
Required: No
Type: String
Update requires: No interruption
DefaultAuthenticationMethod
-
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are
key
orcertificate
.Required: No
Type: String
Update requires: No interruption
Enabled
-
Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application.
Required: No
Type: Boolean
Update requires: No interruption
PrivateKey
-
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
Required: No
Type: String
Update requires: No interruption
TeamId
-
The identifier that's assigned to your Apple Developer Account team. This identifier is used for APNs tokens.
Required: No
Type: String
Update requires: No interruption
TokenKey
-
The authentication key to use for APNs tokens.
Required: No
Type: String
Update requires: No interruption
TokenKeyId
-
The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
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 APNs sandbox channel. This property is retained only for backward compatibility.