CfnGCMChannelProps
- class aws_cdk.aws_pinpoint.CfnGCMChannelProps(*, application_id, api_key=None, default_authentication_method=None, enabled=None, service_json=None)
Bases:
object
Properties for defining a
CfnGCMChannel
.- Parameters:
application_id (
str
) – The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.api_key (
Optional
[str
]) – The Web API key, also called the server key , that you received from Google to communicate with Google services.default_authentication_method (
Optional
[str
]) – The default authentication method used for GCM. Values are either “TOKEN” or “KEY”. Defaults to “KEY”.enabled (
Union
[bool
,IResolvable
,None
]) – Specifies whether to enable the GCM channel for the Amazon Pinpoint application.service_json (
Optional
[str
]) – 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:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_pinpoint as pinpoint cfn_gCMChannel_props = pinpoint.CfnGCMChannelProps( application_id="applicationId", # the properties below are optional api_key="apiKey", default_authentication_method="defaultAuthenticationMethod", enabled=False, service_json="serviceJson" )
Attributes
- api_key
The Web API key, also called the server key , that you received from Google to communicate with Google services.
- application_id
The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
- default_authentication_method
The default authentication method used for GCM.
Values are either “TOKEN” or “KEY”. Defaults to “KEY”.
- enabled
Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
- service_json
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 .