AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::APNSVoipSandboxChannel

CfnAPNSVoipSandboxChannel

A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application. The APNSVoipSandboxChannel resource represents the status and authentication settings of the APNs VoIP sandbox channel for an application.

Import

import { CfnAPNSVoipSandboxChannel } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnAPNSVoipSandboxChannel

Properties

Configuration passed to the constructor as CfnAPNSVoipSandboxChannelProps.

applicationIdRequired
string

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

bundleIdOptional
string

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

certificateOptional
string

The APNs client certificate that you received from Apple. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

defaultAuthenticationMethodOptional
string

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are `key` or `certificate` .

enabledOptional
boolean | IResolvable

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

privateKeyOptional
string

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

teamIdOptional
string

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

tokenKeyOptional
string

The authentication key to use for APNs tokens.

tokenKeyIdOptional
string

The key identifier that's assigned to your APNs signing key. Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pinpoint::APNSVoipSandboxChannelView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pinpoint
CFN TypeAWS::Pinpoint::APNSVoipSandboxChannel
Properties9

Related Constructs

Explore This Service

External Links