software.amazon.awscdk.services.pinpoint

Class CfnAPNSChannel.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnAPNSChannel.Builder

Enclosing class:

CfnAPNSChannel

public static final class CfnAPNSChannel.Builder
extends java.lang.Object

A fluent builder for CfnAPNSChannel.

Method Summary

Modifier and Type	Method and Description
CfnAPNSChannel.Builder	applicationId(java.lang.String applicationId) The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.
CfnAPNSChannel	build()
CfnAPNSChannel.Builder	bundleId(java.lang.String bundleId) The bundle identifier that's assigned to your iOS app.
CfnAPNSChannel.Builder	certificate(java.lang.String certificate) The APNs client certificate that you received from Apple.
static CfnAPNSChannel.Builder	create(Construct scope, java.lang.String id)
CfnAPNSChannel.Builder	defaultAuthenticationMethod(java.lang.String defaultAuthenticationMethod) The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
CfnAPNSChannel.Builder	enabled(java.lang.Boolean enabled) Specifies whether to enable the APNs channel for the application.
CfnAPNSChannel.Builder	enabled(IResolvable enabled) Specifies whether to enable the APNs channel for the application.
CfnAPNSChannel.Builder	privateKey(java.lang.String privateKey) The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
CfnAPNSChannel.Builder	teamId(java.lang.String teamId) The identifier that's assigned to your Apple Developer Account team.
CfnAPNSChannel.Builder	tokenKey(java.lang.String tokenKey) The authentication key to use for APNs tokens.
CfnAPNSChannel.Builder	tokenKeyId(java.lang.String tokenKeyId) The key identifier that's assigned to your APNs signing key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnAPNSChannel.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnAPNSChannel.Builder.

applicationId

public CfnAPNSChannel.Builder applicationId(java.lang.String applicationId)

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

Parameters:

applicationId - The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. This parameter is required.

Returns:

this

bundleId

public CfnAPNSChannel.Builder bundleId(java.lang.String bundleId)

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

This identifier is used for APNs tokens.

Parameters:

bundleId - The bundle identifier that's assigned to your iOS app. This parameter is required.

Returns:

this

certificate

public CfnAPNSChannel.Builder certificate(java.lang.String 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.

Parameters:

certificate - The APNs client certificate that you received from Apple. This parameter is required.

Returns:

this

defaultAuthenticationMethod

public CfnAPNSChannel.Builder defaultAuthenticationMethod(java.lang.String defaultAuthenticationMethod)

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

Valid options are key or certificate .

Parameters:

defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. This parameter is required.

Returns:

this

enabled

public CfnAPNSChannel.Builder enabled(java.lang.Boolean enabled)

Specifies whether to enable the APNs channel for the application.

Parameters:

enabled - Specifies whether to enable the APNs channel for the application. This parameter is required.

Returns:

this

enabled

public CfnAPNSChannel.Builder enabled(IResolvable enabled)

Specifies whether to enable the APNs channel for the application.

Parameters:

enabled - Specifies whether to enable the APNs channel for the application. This parameter is required.

Returns:

this

privateKey

public CfnAPNSChannel.Builder privateKey(java.lang.String privateKey)

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

Parameters:

privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. This parameter is required.

Returns:

this

teamId

public CfnAPNSChannel.Builder teamId(java.lang.String teamId)

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

This identifier is used for APNs tokens.

Parameters:

teamId - The identifier that's assigned to your Apple Developer Account team. This parameter is required.

Returns:

this

tokenKey

public CfnAPNSChannel.Builder tokenKey(java.lang.String tokenKey)

The authentication key to use for APNs tokens.

Parameters:

tokenKey - The authentication key to use for APNs tokens. This parameter is required.

Returns:

this

tokenKeyId

public CfnAPNSChannel.Builder tokenKeyId(java.lang.String tokenKeyId)

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.

Parameters:

tokenKeyId - The key identifier that's assigned to your APNs signing key. This parameter is required.

Returns:

this

build

public CfnAPNSChannel build()