Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.723Z") @Stability(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();

  • Method Details

    • getApplicationId

      @Stability(Stable) @NotNull String getApplicationId()
      The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.

    • getBundleId

      @Stability(Stable) @Nullable default String getBundleId()
      The bundle identifier that's assigned to your iOS app.

      This identifier is used for APNs tokens.

    • 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.

    • 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 .

    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      Specifies whether to enable the APNs channel for the application.

    • 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.

    • 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.

    • getTokenKey

      @Stability(Stable) @Nullable default String getTokenKey()
      The authentication key to use for APNs tokens.

    • 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.

    • builder

      @Stability(Stable) static CfnAPNSChannelProps.Builder builder()
      Returns:
      a CfnAPNSChannelProps.Builder of CfnAPNSChannelProps