CfnGCMChannelProps

class aws_cdk.aws_pinpoint.CfnGCMChannelProps(*, api_key, application_id, enabled=None)

Bases: object

Properties for defining a CfnGCMChannel.

Parameters
  • api_key (str) – The Web API key, also called the server key , that you received from Google to communicate with Google services.

  • application_id (str) – The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether to enable the GCM channel for the Amazon Pinpoint application.

Link

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.
import aws_cdk.aws_pinpoint as pinpoint

cfn_gCMChannel_props = pinpoint.CfnGCMChannelProps(
    api_key="apiKey",
    application_id="applicationId",

    # the properties below are optional
    enabled=False
)

Attributes

api_key

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

Link

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

Return type

str

application_id

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

Link

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

Return type

str

enabled

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

Link

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

Return type

Union[bool, IResolvable, None]