Package software.amazon.awscdk.services.pinpoint

Interface CfnAPNSVoipChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAPNSVoipChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:14.205Z")
@Stability(Stable)
public interface CfnAPNSVoipChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAPNSVoipChannel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnAPNSVoipChannelProps cfnAPNSVoipChannelProps = CfnAPNSVoipChannelProps.builder()
         .applicationId("applicationId")
         // the properties below are optional
         .bundleId("bundleId")
         .certificate("certificate")
         .defaultAuthenticationMethod("defaultAuthenticationMethod")
         .enabled(false)
         .privateKey("privateKey")
         .teamId("teamId")
         .tokenKey("tokenKey")
         .tokenKeyId("tokenKeyId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAPNSVoipChannelProps.Builder	A builder for CfnAPNSVoipChannelProps
static final class	CfnAPNSVoipChannelProps.Jsii$Proxy	An implementation for CfnAPNSVoipChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnAPNSVoipChannelProps.Builder	builder()
String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
default String	getBundleId()	The bundle identifier that's assigned to your iOS app.
default String	getCertificate()	The APNs client certificate that you received from Apple.
default String	getDefaultAuthenticationMethod()	The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
default Object	getEnabled()	Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
default String	getPrivateKey()	The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
default String	getTeamId()	The identifier that's assigned to your Apple Developer Account team.
default String	getTokenKey()	The authentication key to use for APNs tokens.
default String	getTokenKeyId()	The key identifier that's assigned to your APNs signing key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

See Also:

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

getBundleId

@Stability(Stable)
@Nullable
default String getBundleId()

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

This identifier is used for APNs tokens.

See Also:

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

getCertificate

@Stability(Stable)
@Nullable
default String getCertificate()

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.

See Also:

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

getDefaultAuthenticationMethod

@Stability(Stable)
@Nullable
default String getDefaultAuthenticationMethod()

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

Valid options are key or certificate .

See Also:

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

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

See Also:

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

getPrivateKey

@Stability(Stable)
@Nullable
default String getPrivateKey()

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

See Also:

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

getTeamId

@Stability(Stable)
@Nullable
default String getTeamId()

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

This identifier is used for APNs tokens.

See Also:

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

getTokenKey

@Stability(Stable)
@Nullable
default String getTokenKey()

The authentication key to use for APNs tokens.

See Also:

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

getTokenKeyId

@Stability(Stable)
@Nullable
default String getTokenKeyId()

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.

See Also:

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

builder

@Stability(Stable)
static CfnAPNSVoipChannelProps.Builder builder()

Returns:

a CfnAPNSVoipChannelProps.Builder of CfnAPNSVoipChannelProps