Try AWS Native preview for resources not in the classic version.
aws.pinpoint.GcmChannel
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a Pinpoint GCM Channel resource.
Note: Api Key argument will be stored in the raw state as plain-text.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var app = new Aws.Pinpoint.App("app");
var gcm = new Aws.Pinpoint.GcmChannel("gcm", new()
{
ApplicationId = app.ApplicationId,
ApiKey = "api_key",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/pinpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
app, err := pinpoint.NewApp(ctx, "app", nil)
if err != nil {
return err
}
_, err = pinpoint.NewGcmChannel(ctx, "gcm", &pinpoint.GcmChannelArgs{
ApplicationId: app.ApplicationId,
ApiKey: pulumi.String("api_key"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.App;
import com.pulumi.aws.pinpoint.GcmChannel;
import com.pulumi.aws.pinpoint.GcmChannelArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var app = new App("app");
var gcm = new GcmChannel("gcm", GcmChannelArgs.builder()
.applicationId(app.applicationId())
.apiKey("api_key")
.build());
}
}
import pulumi
import pulumi_aws as aws
app = aws.pinpoint.App("app")
gcm = aws.pinpoint.GcmChannel("gcm",
application_id=app.application_id,
api_key="api_key")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const app = new aws.pinpoint.App("app", {});
const gcm = new aws.pinpoint.GcmChannel("gcm", {
applicationId: app.applicationId,
apiKey: "api_key",
});
resources:
gcm:
type: aws:pinpoint:GcmChannel
properties:
applicationId: ${app.applicationId}
apiKey: api_key
app:
type: aws:pinpoint:App
Create GcmChannel Resource
new GcmChannel(name: string, args: GcmChannelArgs, opts?: CustomResourceOptions);
@overload
def GcmChannel(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
application_id: Optional[str] = None,
enabled: Optional[bool] = None)
@overload
def GcmChannel(resource_name: str,
args: GcmChannelArgs,
opts: Optional[ResourceOptions] = None)
func NewGcmChannel(ctx *Context, name string, args GcmChannelArgs, opts ...ResourceOption) (*GcmChannel, error)
public GcmChannel(string name, GcmChannelArgs args, CustomResourceOptions? opts = null)
public GcmChannel(String name, GcmChannelArgs args)
public GcmChannel(String name, GcmChannelArgs args, CustomResourceOptions options)
type: aws:pinpoint:GcmChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GcmChannelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GcmChannelArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GcmChannelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GcmChannelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GcmChannelArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
GcmChannel Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GcmChannel resource accepts the following input properties:
- Api
Key string Platform credential API key from Google.
- Application
Id string The application ID.
- Enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- Api
Key string Platform credential API key from Google.
- Application
Id string The application ID.
- Enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key String Platform credential API key from Google.
- application
Id String The application ID.
- enabled Boolean
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key string Platform credential API key from Google.
- application
Id string The application ID.
- enabled boolean
Whether the channel is enabled or disabled. Defaults to
true
.
- api_
key str Platform credential API key from Google.
- application_
id str The application ID.
- enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key String Platform credential API key from Google.
- application
Id String The application ID.
- enabled Boolean
Whether the channel is enabled or disabled. Defaults to
true
.
Outputs
All input properties are implicitly available as output properties. Additionally, the GcmChannel resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing GcmChannel Resource
Get an existing GcmChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GcmChannelState, opts?: CustomResourceOptions): GcmChannel
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_key: Optional[str] = None,
application_id: Optional[str] = None,
enabled: Optional[bool] = None) -> GcmChannel
func GetGcmChannel(ctx *Context, name string, id IDInput, state *GcmChannelState, opts ...ResourceOption) (*GcmChannel, error)
public static GcmChannel Get(string name, Input<string> id, GcmChannelState? state, CustomResourceOptions? opts = null)
public static GcmChannel get(String name, Output<String> id, GcmChannelState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Key string Platform credential API key from Google.
- Application
Id string The application ID.
- Enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- Api
Key string Platform credential API key from Google.
- Application
Id string The application ID.
- Enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key String Platform credential API key from Google.
- application
Id String The application ID.
- enabled Boolean
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key string Platform credential API key from Google.
- application
Id string The application ID.
- enabled boolean
Whether the channel is enabled or disabled. Defaults to
true
.
- api_
key str Platform credential API key from Google.
- application_
id str The application ID.
- enabled bool
Whether the channel is enabled or disabled. Defaults to
true
.
- api
Key String Platform credential API key from Google.
- application
Id String The application ID.
- enabled Boolean
Whether the channel is enabled or disabled. Defaults to
true
.
Import
Using pulumi import
, import Pinpoint GCM Channel using the application-id
. For example:
$ pulumi import aws:pinpoint/gcmChannel:GcmChannel gcm application-id
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.