CfnAPNSChannelProps Struct
Properties for defining a CfnAPNSChannel.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
const cfnAPNSChannelProps: pinpoint.CfnAPNSChannelProps = {
applicationId: 'applicationId',
// the properties below are optional
bundleId: 'bundleId',
certificate: 'certificate',
defaultAuthenticationMethod: 'defaultAuthenticationMethod',
enabled: false,
privateKey: 'privateKey',
teamId: 'teamId',
tokenKey: 'tokenKey',
tokenKeyId: 'tokenKeyId',
};
Properties
applicationIdstringapplication_idstrapplicationIdStringApplicationIdstringApplicationId*stringrequired#The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.
bundleIdoptionalstringbundle_idoptionalstrbundleIdoptionalStringBundleIdoptionalstringBundleIdoptional*string#The bundle identifier that's assigned to your iOS app.
This identifier is used for APNs tokens.
certificateoptionalstringcertificateoptionalstrcertificateoptionalStringCertificateoptionalstringCertificateoptional*string#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.
defaultAuthenticationMethodoptionalstringdefault_authentication_methodoptionalstrdefaultAuthenticationMethodoptionalStringDefaultAuthenticationMethodoptionalstringDefaultAuthenticationMethodoptional*string#The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
Valid options are key or certificate .
enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#Specifies whether to enable the APNs channel for the application.
privateKeyoptionalstringprivate_keyoptionalstrprivateKeyoptionalStringPrivateKeyoptionalstringPrivateKeyoptional*string#The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
teamIdoptionalstringteam_idoptionalstrteamIdoptionalStringTeamIdoptionalstringTeamIdoptional*string#The identifier that's assigned to your Apple Developer Account team.
This identifier is used for APNs tokens.
tokenKeyoptionalstringtoken_keyoptionalstrtokenKeyoptionalStringTokenKeyoptionalstringTokenKeyoptional*string#The authentication key to use for APNs tokens.
tokenKeyIdoptionalstringtoken_key_idoptionalstrtokenKeyIdoptionalStringTokenKeyIdoptionalstringTokenKeyIdoptional*string#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.