aws-cdk-lib.aws_pinpoint.CfnAPNSSandboxChannelProps

interface CfnAPNSSandboxChannelProps

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnAPNSSandboxChannelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnAPNSSandboxChannelProps
Javasoftware.amazon.awscdk.services.pinpoint.CfnAPNSSandboxChannelProps
Pythonaws_cdk.aws_pinpoint.CfnAPNSSandboxChannelProps
TypeScript aws-cdk-lib » aws_pinpoint » CfnAPNSSandboxChannelProps

Properties for defining a CfnAPNSSandboxChannel.

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 cfnAPNSSandboxChannelProps: pinpoint.CfnAPNSSandboxChannelProps = {
  applicationId: 'applicationId',

  // the properties below are optional
  bundleId: 'bundleId',
  certificate: 'certificate',
  defaultAuthenticationMethod: 'defaultAuthenticationMethod',
  enabled: false,
  privateKey: 'privateKey',
  teamId: 'teamId',
  tokenKey: 'tokenKey',
  tokenKeyId: 'tokenKeyId',
};

Properties

NameTypeDescription
applicationIdstringThe unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to.
bundleId?stringThe bundle identifier that's assigned to your iOS app.
certificate?stringThe APNs client certificate that you received from Apple.
defaultAuthenticationMethod?stringThe default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
enabled?boolean | IResolvableSpecifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application.
privateKey?stringThe private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
teamId?stringThe identifier that's assigned to your Apple Developer Account team.
tokenKey?stringThe authentication key to use for APNs tokens.
tokenKeyId?stringThe key identifier that's assigned to your APNs signing key.

applicationId

Type: string

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


bundleId?

Type: string (optional)

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

This identifier is used for APNs tokens.


certificate?

Type: string (optional)

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.


defaultAuthenticationMethod?

Type: string (optional)

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

Valid options are key or certificate .


enabled?

Type: boolean | IResolvable (optional)

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


privateKey?

Type: string (optional)

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


teamId?

Type: string (optional)

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

This identifier is used for APNs tokens.


tokenKey?

Type: string (optional)

The authentication key to use for APNs tokens.


tokenKeyId?

Type: string (optional)

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.