interface CfnAPNSChannelProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pinpoint.CfnAPNSChannelProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnAPNSChannelProps |
![]() | software.amazon.awscdk.services.pinpoint.CfnAPNSChannelProps |
![]() | aws_cdk.aws_pinpoint.CfnAPNSChannelProps |
![]() | aws-cdk-lib » aws_pinpoint » CfnAPNSChannelProps |
Properties for defining a CfnAPNSChannel
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html
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 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
Name | Type | Description |
---|---|---|
application | string | The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. |
bundle | string | The bundle identifier that's assigned to your iOS app. |
certificate? | string | The APNs client certificate that you received from Apple. |
default | string | The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. |
enabled? | boolean | IResolvable | Specifies whether to enable the APNs channel for the application. |
private | string | The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. |
team | string | The identifier that's assigned to your Apple Developer Account team. |
token | string | The authentication key to use for APNs tokens. |
token | string | The key identifier that's assigned to your APNs signing key. |
applicationId
Type:
string
The unique identifier for the Amazon Pinpoint application that the APNs 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 channel for the 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.