Interface ICfnGCMChannelProps

Properties for defining a CfnGCMChannel.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnGCMChannelProps

Syntax (vb)

Public Interface ICfnGCMChannelProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var cfnGCMChannelProps = new CfnGCMChannelProps {
    ApplicationId = "applicationId",

    // the properties below are optional
    ApiKey = "apiKey",
    DefaultAuthenticationMethod = "defaultAuthenticationMethod",
    Enabled = false,
    ServiceJson = "serviceJson"
};

Synopsis

Properties

ApiKey	The Web API key, also called the server key , that you received from Google to communicate with Google services.
ApplicationId	The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
DefaultAuthenticationMethod	The default authentication method used for GCM.
Enabled	Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
ServiceJson	The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

Properties

ApiKey

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

virtual string ApiKey { get; }

Property Value

System.String

Remarks

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

ApplicationId

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

string ApplicationId { get; }

Property Value

System.String

Remarks

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

DefaultAuthenticationMethod

The default authentication method used for GCM.

virtual string DefaultAuthenticationMethod { get; }

Property Value

System.String

Remarks

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

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

Enabled

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

virtual object Enabled { get; }

Property Value

System.Object

Remarks

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

ServiceJson

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

virtual string ServiceJson { get; }

Property Value

System.String

Remarks

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#cfn-pinpoint-gcmchannel-servicejson