Package software.amazon.awscdk.services.pinpoint

Interface CfnGCMChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGCMChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:43.197Z")
@Stability(Stable)
public interface CfnGCMChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGCMChannel.

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.*;
 CfnGCMChannelProps cfnGCMChannelProps = CfnGCMChannelProps.builder()
         .applicationId("applicationId")
         // the properties below are optional
         .apiKey("apiKey")
         .defaultAuthenticationMethod("defaultAuthenticationMethod")
         .enabled(false)
         .serviceJson("serviceJson")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGCMChannelProps.Builder	builder()
default String	getApiKey()	The Web API key, also called the server key , that you received from Google to communicate with Google services.
String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
default String	getDefaultAuthenticationMethod()	The default authentication method used for GCM.
default Object	getEnabled()	Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
default String	getServiceJson()	The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-applicationid

getApiKey

@Stability(Stable)
@Nullable
default String getApiKey()

The Web API key, also called the server key , that you received from Google to communicate with Google services.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-apikey

getDefaultAuthenticationMethod

@Stability(Stable)
@Nullable
default String getDefaultAuthenticationMethod()

The default authentication method used for GCM.

Values are either "TOKEN" or "KEY". Defaults to "KEY".

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-defaultauthenticationmethod

getEnabled

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

Specifies whether to enable the GCM channel for the Amazon Pinpoint application.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-enabled

getServiceJson

@Stability(Stable)
@Nullable
default String getServiceJson()

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

For more information see Migrate from legacy FCM APIs to HTTP v1 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-servicejson

builder

@Stability(Stable)
static CfnGCMChannelProps.Builder builder()

Returns:

a CfnGCMChannelProps.Builder of CfnGCMChannelProps