software.amazon.awscdk.services.pinpoint

Interface CfnAPNSChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAPNSChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.180Z")
 @Stability(value=Stable)
public interface CfnAPNSChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAPNSChannel`.

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.*;
 CfnAPNSChannelProps cfnAPNSChannelProps = CfnAPNSChannelProps.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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAPNSChannelProps.Builder	builder()
String	getApplicationId() The unique identifier for the Amazon Pinpoint application that the APNs 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 channel for the 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 Detail

getApplicationId

@Stability(value=Stable)
 @NotNull
String getApplicationId()

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

getBundleId

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

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

This identifier is used for APNs tokens.

getCertificate

@Stability(value=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.

getDefaultAuthenticationMethod

@Stability(value=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 .

getEnabled

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

Specifies whether to enable the APNs channel for the application.

getPrivateKey

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

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

getTeamId

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

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

This identifier is used for APNs tokens.

getTokenKey

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

The authentication key to use for APNs tokens.

getTokenKeyId

@Stability(value=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.

builder

@Stability(value=Stable)
static CfnAPNSChannelProps.Builder builder()

Returns:

a CfnAPNSChannelProps.Builder of CfnAPNSChannelProps