Docs Home
AWS v6.81.0 published on Tuesday, May 20, 2025 by Pulumi
aws.pinpoint.GcmChannel
Explore with Pulumi AI
Provides a Pinpoint GCM Channel resource.
Note: Credentials (Service Account JSON and API Key) will be stored in the raw state as plain-text.
Import
Using pulumi import, import Pinpoint GCM Channel using the application-id. For example:
$ pulumi import aws:pinpoint/gcmChannel:GcmChannel gcm application-id
Create GcmChannel Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GcmChannel(name: string, args: GcmChannelArgs, opts?: CustomResourceOptions);@overload
def GcmChannel(resource_name: str,
args: GcmChannelArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GcmChannel(resource_name: str,
opts: Optional[ResourceOptions] = None,
application_id: Optional[str] = None,
api_key: Optional[str] = None,
default_authentication_method: Optional[str] = None,
enabled: Optional[bool] = None,
service_json: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var gcmChannelResource = new Aws.Pinpoint.GcmChannel("gcmChannelResource", new()
{
ApplicationId = "string",
ApiKey = "string",
DefaultAuthenticationMethod = "string",
Enabled = false,
ServiceJson = "string",
});
example, err := pinpoint.NewGcmChannel(ctx, "gcmChannelResource", &pinpoint.GcmChannelArgs{
ApplicationId: pulumi.String("string"),
ApiKey: pulumi.String("string"),
DefaultAuthenticationMethod: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ServiceJson: pulumi.String("string"),
})
var gcmChannelResource = new GcmChannel("gcmChannelResource", GcmChannelArgs.builder()
.applicationId("string")
.apiKey("string")
.defaultAuthenticationMethod("string")
.enabled(false)
.serviceJson("string")
.build());
gcm_channel_resource = aws.pinpoint.GcmChannel("gcmChannelResource",
application_id="string",
api_key="string",
default_authentication_method="string",
enabled=False,
service_json="string")
const gcmChannelResource = new aws.pinpoint.GcmChannel("gcmChannelResource", {
applicationId: "string",
apiKey: "string",
defaultAuthenticationMethod: "string",
enabled: false,
serviceJson: "string",
});
type: aws:pinpoint:GcmChannel
properties:
apiKey: string
applicationId: string
defaultAuthenticationMethod: string
enabled: false
serviceJson: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GcmChannel resource accepts the following input properties:
- Application
Id string - The application ID.
- Api
Key string - Platform credential API key from Google.
- Default
Authentication stringMethod - Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Service
Json string
- Application
Id string - The application ID.
- Api
Key string - Platform credential API key from Google.
- Default
Authentication stringMethod - Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Service
Json string
- application
Id String - The application ID.
- api
Key String - Platform credential API key from Google.
- default
Authentication StringMethod - enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json String
- application
Id string - The application ID.
- api
Key string - Platform credential API key from Google.
- default
Authentication stringMethod - enabled boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json string
- application_
id str - The application ID.
- api_
key str - Platform credential API key from Google.
- default_
authentication_ strmethod - enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - service_
json str
- application
Id String - The application ID.
- api
Key String - Platform credential API key from Google.
- default
Authentication StringMethod - enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json String
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,
default_authentication_method: Optional[str] = None,
enabled: Optional[bool] = None,
service_json: Optional[str] = None) -> GcmChannelfunc 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)resources: _: type: aws:pinpoint:GcmChannel get: id: ${id}- 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.
- Default
Authentication stringMethod - Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Service
Json string
- Api
Key string - Platform credential API key from Google.
- Application
Id string - The application ID.
- Default
Authentication stringMethod - Enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - Service
Json string
- api
Key String - Platform credential API key from Google.
- application
Id String - The application ID.
- default
Authentication StringMethod - enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json String
- api
Key string - Platform credential API key from Google.
- application
Id string - The application ID.
- default
Authentication stringMethod - enabled boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json string
- api_
key str - Platform credential API key from Google.
- application_
id str - The application ID.
- default_
authentication_ strmethod - enabled bool
- Whether the channel is enabled or disabled. Defaults to
true. - service_
json str
- api
Key String - Platform credential API key from Google.
- application
Id String - The application ID.
- default
Authentication StringMethod - enabled Boolean
- Whether the channel is enabled or disabled. Defaults to
true. - service
Json String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.