Package software.amazon.awscdk.services.pinpoint

Class CfnGCMChannel

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.CfnGCMChannel
All Implemented Interfaces:
IInspectable, IGCMChannelRef, 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.196Z") @Stability(Stable) public class CfnGCMChannel extends CfnResource implements IInspectable, IGCMChannelRef
A channel is a type of platform that you can deliver messages to.

You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaced the Google Cloud Messaging (GCM) service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application.

The GCMChannel resource represents the status and authentication settings of the GCM 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.*;
 CfnGCMChannel cfnGCMChannel = CfnGCMChannel.Builder.create(this, "MyCfnGCMChannel")
         .applicationId("applicationId")
         // the properties below are optional
         .apiKey("apiKey")
         .defaultAuthenticationMethod("defaultAuthenticationMethod")
         .enabled(false)
         .serviceJson("serviceJson")
         .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

    • CfnGCMChannel

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

    • CfnGCMChannel

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

    • CfnGCMChannel

      @Stability(Stable) public CfnGCMChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGCMChannelProps 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.

    • getAttrId

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

      This property is retained only for backward compatibility.

    • getCfnProperties

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

    • getGcmChannelRef

      @Stability(Stable) @NotNull public GCMChannelReference getGcmChannelRef()
      A reference to a GCMChannel resource.
      Specified by:
      getGcmChannelRef in interface IGCMChannelRef

    • getApplicationId

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

    • setApplicationId

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

    • getApiKey

      @Stability(Stable) @Nullable public String getApiKey()
      The Web API key, also called the server key , that you received from Google to communicate with Google services.

    • setApiKey

      @Stability(Stable) public void setApiKey(@Nullable String value)
      The Web API key, also called the server key , that you received from Google to communicate with Google services.

    • getDefaultAuthenticationMethod

      @Stability(Stable) @Nullable public String getDefaultAuthenticationMethod()
      The default authentication method used for GCM.

    • setDefaultAuthenticationMethod

      @Stability(Stable) public void setDefaultAuthenticationMethod(@Nullable String value)
      The default authentication method used for GCM.

    • getEnabled

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

      Returns union: either Boolean or IResolvable

    • setEnabled

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

    • setEnabled

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

    • getServiceJson

      @Stability(Stable) @Nullable public String getServiceJson()
      The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

    • setServiceJson

      @Stability(Stable) public void setServiceJson(@Nullable String value)
      The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.