Package software.amazon.awscdk.services.pinpoint

Class CfnAPNSChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.pinpoint.CfnAPNSChannel
All Implemented Interfaces:
IInspectable, IAPNSChannelRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:43.126Z") @Stability(Stable) public class CfnAPNSChannel extends CfnResource implements IInspectable, IAPNSChannelRef
A channel is a type of platform that you can deliver messages to.

You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application.

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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.*;
 CfnAPNSChannel cfnAPNSChannel = CfnAPNSChannel.Builder.create(this, "MyCfnAPNSChannel")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAPNSChannel

      protected CfnAPNSChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAPNSChannel

      protected CfnAPNSChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAPNSChannel

      @Stability(Stable) public CfnAPNSChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAPNSChannelProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApnsChannelRef

      @Stability(Stable) @NotNull public APNSChannelReference getApnsChannelRef()
      A reference to a APNSChannel resource.
      Specified by:
      getApnsChannelRef in interface IAPNSChannelRef

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      (Deprecated) An identifier for the APNs channel.

      This property is retained only for backward compatibility.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

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

    • setApplicationId

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

    • getBundleId

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

    • setBundleId

      @Stability(Stable) public void setBundleId(@Nullable String value)
      The bundle identifier that's assigned to your iOS app.

    • getCertificate

      @Stability(Stable) @Nullable public String getCertificate()
      The APNs client certificate that you received from Apple.

    • setCertificate

      @Stability(Stable) public void setCertificate(@Nullable String value)
      The APNs client certificate that you received from Apple.

    • getDefaultAuthenticationMethod

      @Stability(Stable) @Nullable public String getDefaultAuthenticationMethod()
      The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

    • setDefaultAuthenticationMethod

      @Stability(Stable) public void setDefaultAuthenticationMethod(@Nullable String value)
      The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

    • getEnabled

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

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether to enable the APNs channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether to enable the APNs channel for the application.

    • getPrivateKey

      @Stability(Stable) @Nullable public String getPrivateKey()
      The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

    • setPrivateKey

      @Stability(Stable) public void setPrivateKey(@Nullable String value)
      The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

    • getTeamId

      @Stability(Stable) @Nullable public String getTeamId()
      The identifier that's assigned to your Apple Developer Account team.

    • setTeamId

      @Stability(Stable) public void setTeamId(@Nullable String value)
      The identifier that's assigned to your Apple Developer Account team.

    • getTokenKey

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

    • setTokenKey

      @Stability(Stable) public void setTokenKey(@Nullable String value)
      The authentication key to use for APNs tokens.

    • getTokenKeyId

      @Stability(Stable) @Nullable public String getTokenKeyId()
      The key identifier that's assigned to your APNs signing key.

    • setTokenKeyId

      @Stability(Stable) public void setTokenKeyId(@Nullable String value)
      The key identifier that's assigned to your APNs signing key.