aws-cdk-lib.aws_pinpoint.CfnAPNSVoipChannelProps

CfnAPNSVoipChannelProps Struct

Properties for defining a CfnAPNSVoipChannel.

CfnAPNSVoipChannelProps

used as props by

• CfnAPNSVoipChannel

Source

Generated code

Example

// 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 cfnAPNSVoipChannelProps: pinpoint.CfnAPNSVoipChannelProps = {
  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 VoIP channel applies to.

bundleIdstringbundle_idstrbundleIdStringBundleIdstringBundleId*string#

The bundle identifier that's assigned to your iOS app.

This identifier is used for APNs tokens.

certificatestringcertificatestrcertificateStringCertificatestringCertificate*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.

defaultAuthenticationMethodstringdefault_authentication_methodstrdefaultAuthenticationMethodStringDefaultAuthenticationMethodstringDefaultAuthenticationMethod*string#

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Valid options are key or certificate .

enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}#

Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.

privateKeystringprivate_keystrprivateKeyStringPrivateKeystringPrivateKey*string#

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

teamIdstringteam_idstrteamIdStringTeamIdstringTeamId*string#

The identifier that's assigned to your Apple Developer Account team.

This identifier is used for APNs tokens.

tokenKeystringtoken_keystrtokenKeyStringTokenKeystringTokenKey*string#

The authentication key to use for APNs tokens.

tokenKeyIdstringtoken_key_idstrtokenKeyIdStringTokenKeyIdstringTokenKeyId*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.