Class GcmChannel
Provides a Pinpoint GCM Channel resource.
Note: Api Key argument will be stored in the raw state as plain-text. Read more about sensitive data in state.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var app = new Aws.Pinpoint.App("app", new Aws.Pinpoint.AppArgs
{
});
var gcm = new Aws.Pinpoint.GcmChannel("gcm", new Aws.Pinpoint.GcmChannelArgs
{
ApiKey = "api_key",
ApplicationId = app.ApplicationId,
});
}
}
Inherited Members
Namespace: Pulumi.Aws.Pinpoint
Assembly: Pulumi.Aws.dll
Syntax
public class GcmChannel : CustomResource
Constructors
View SourceGcmChannel(String, GcmChannelArgs, CustomResourceOptions)
Create a GcmChannel resource with the given unique name, arguments, and options.
Declaration
public GcmChannel(string name, GcmChannelArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| GcmChannelArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceApiKey
Platform credential API key from Google.
Declaration
public Output<string> ApiKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ApplicationId
The application ID.
Declaration
public Output<string> ApplicationId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Enabled
Whether the channel is enabled or disabled. Defaults to true.
Declaration
public Output<bool?> Enabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Methods
View SourceGet(String, Input<String>, GcmChannelState, CustomResourceOptions)
Get an existing GcmChannel resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static GcmChannel Get(string name, Input<string> id, GcmChannelState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| GcmChannelState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| GcmChannel |