CfnAPNSVoipChannelProps¶

class aws_cdk.aws_pinpoint.CfnAPNSVoipChannelProps(*, application_id, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None)¶

Bases: object

Properties for defining a CfnAPNSVoipChannel.

Parameters

application_id (str) – The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
bundle_id (Optional[str]) – The bundle identifier that’s assigned to your iOS app. This identifier is used for APNs tokens.
certificate (Optional[str]) – 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.
default_authentication_method (Optional[str]) – The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. Valid options are key or certificate .
enabled (Union[bool, IResolvable, None]) – Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
private_key (Optional[str]) – The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
team_id (Optional[str]) – The identifier that’s assigned to your Apple Developer Account team. This identifier is used for APNs tokens.
token_key (Optional[str]) – The authentication key to use for APNs tokens.
token_key_id (Optional[str]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

cfn_aPNSVoip_channel_props = pinpoint.CfnAPNSVoipChannelProps(
    application_id="applicationId",

    # the properties below are optional
    bundle_id="bundleId",
    certificate="certificate",
    default_authentication_method="defaultAuthenticationMethod",
    enabled=False,
    private_key="privateKey",
    team_id="teamId",
    token_key="tokenKey",
    token_key_id="tokenKeyId"
)

Attributes

application_id¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-applicationid
Return type: str

bundle_id¶

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

This identifier is used for APNs tokens.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-bundleid
Return type: Optional[str]

certificate¶

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-certificate
Return type: Optional[str]

default_authentication_method¶

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

Valid options are key or certificate .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-defaultauthenticationmethod
Return type: Optional[str]

enabled¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-enabled
Return type: Union[bool, IResolvable, None]

private_key¶

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-privatekey
Return type: Optional[str]

team_id¶

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

This identifier is used for APNs tokens.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-teamid
Return type: Optional[str]

token_key¶

The authentication key to use for APNs tokens.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkey
Return type: Optional[str]

token_key_id¶

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkeyid
Return type: Optional[str]