Interface ICfnAPNSVoipSandboxChannelProps

Properties for defining a CfnAPNSVoipSandboxChannel.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnAPNSVoipSandboxChannelProps

Syntax (vb)

Public Interface ICfnAPNSVoipSandboxChannelProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var cfnAPNSVoipSandboxChannelProps = new CfnAPNSVoipSandboxChannelProps {
    ApplicationId = "applicationId",

    // the properties below are optional
    BundleId = "bundleId",
    Certificate = "certificate",
    DefaultAuthenticationMethod = "defaultAuthenticationMethod",
    Enabled = false,
    PrivateKey = "privateKey",
    TeamId = "teamId",
    TokenKey = "tokenKey",
    TokenKeyId = "tokenKeyId"
};

Synopsis

Properties

ApplicationId	The unique identifier for the application that the APNs VoIP sandbox channel applies to.
BundleId	The bundle identifier that's assigned to your iOS app.
Certificate	The APNs client certificate that you received from Apple.
DefaultAuthenticationMethod	The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
Enabled	Specifies whether the APNs VoIP sandbox channel is enabled for the application.
PrivateKey	The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
TeamId	The identifier that's assigned to your Apple developer account team.
TokenKey	The authentication key to use for APNs tokens.
TokenKeyId	The key identifier that's assigned to your APNs signing key.

Properties

ApplicationId

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

string ApplicationId { get; }

Property Value

System.String

Remarks

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

BundleId

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

virtual string BundleId { get; }

Property Value

System.String

Remarks

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.

virtual string Certificate { get; }

Property Value

System.String

Remarks

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

DefaultAuthenticationMethod

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

virtual string DefaultAuthenticationMethod { get; }

Property Value

System.String

Remarks

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.

virtual object Enabled { get; }

Property Value

System.Object

Remarks

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

PrivateKey

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

virtual string PrivateKey { get; }

Property Value

System.String

Remarks

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

TeamId

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

virtual string TeamId { get; }

Property Value

System.String

Remarks

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

TokenKey

The authentication key to use for APNs tokens.

virtual string TokenKey { get; }

Property Value

System.String

Remarks

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

TokenKeyId

The key identifier that's assigned to your APNs signing key.

virtual string TokenKeyId { get; }

Property Value

System.String

Remarks

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