CfnAPNSVoipSandboxChannelProps

class aws_cdk.aws_pinpoint.CfnAPNSVoipSandboxChannelProps(*, 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 CfnAPNSVoipSandboxChannel.

Parameters:
  • application_id (str) – The unique identifier for the application that the APNs VoIP sandbox 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 the APNs sandbox environment 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 the APNs VoIP sandbox channel is enabled for the application.

  • private_key (Optional[str]) – The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

  • 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 the APNs sandbox environment by using APNs tokens.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_aPNSVoip_sandbox_channel_props = pinpoint.CfnAPNSVoipSandboxChannelProps(
    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 application that the APNs VoIP sandbox channel applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-applicationid

bundle_id

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

This identifier is used for APNs tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-bundleid

certificate

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-certificate

default_authentication_method

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

Valid options are key or certificate .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-defaultauthenticationmethod

enabled

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-enabled

private_key

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-privatekey

team_id

The identifier that’s assigned to your Apple developer account team.

This identifier is used for APNs tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-teamid

token_key

The authentication key to use for APNs tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkey

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 the APNs sandbox environment by using APNs tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkeyid