@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
103 lines (102 loc) • 3.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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:
*
* ```sh
* $ pulumi import aws:pinpoint/gcmChannel:GcmChannel gcm application-id
* ```
*/
export declare class GcmChannel extends pulumi.CustomResource {
/**
* Get an existing GcmChannel resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GcmChannelState, opts?: pulumi.CustomResourceOptions): GcmChannel;
/**
* Returns true if the given object is an instance of GcmChannel. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is GcmChannel;
/**
* Platform credential API key from Google.
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* The application ID.
*/
readonly applicationId: pulumi.Output<string>;
readonly defaultAuthenticationMethod: pulumi.Output<string | undefined>;
/**
* Whether the channel is enabled or disabled. Defaults to `true`.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
readonly serviceJson: pulumi.Output<string | undefined>;
/**
* Create a GcmChannel resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: GcmChannelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GcmChannel resources.
*/
export interface GcmChannelState {
/**
* Platform credential API key from Google.
*/
apiKey?: pulumi.Input<string>;
/**
* The application ID.
*/
applicationId?: pulumi.Input<string>;
defaultAuthenticationMethod?: pulumi.Input<string>;
/**
* Whether the channel is enabled or disabled. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
serviceJson?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a GcmChannel resource.
*/
export interface GcmChannelArgs {
/**
* Platform credential API key from Google.
*/
apiKey?: pulumi.Input<string>;
/**
* The application ID.
*/
applicationId: pulumi.Input<string>;
defaultAuthenticationMethod?: pulumi.Input<string>;
/**
* Whether the channel is enabled or disabled. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
serviceJson?: pulumi.Input<string>;
}