@statsig/pulumi-statsig
Version:
A Pulumi package for creating and managing Statsig resources.
91 lines (90 loc) • 3.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to configure API keys for your Statsig project.
*
* To learn more about API keys, see [API Keys Documentation](https://docs.statsig.com/sdk-keys/api-keys/)
*
* To learn more about the API powering this resource, see [Keys API Documentation](https://docs.statsig.com/console-api/keys)
*
* > Note: This resource requires a Console API Key with the following scope: `can access other keys`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as statsig from "@pulumi/statsig";
*
* const serverKey = new statsig.Keys("server_key", {
* description: "A short description of what this server key is used for.",
* type: "SERVER",
* environments: ["production"],
* });
* const clientKey = new statsig.Keys("client_key", {
* description: "A short description of what this client key is used for.",
* type: "CLIENT",
* environments: ["production"],
* scopes: ["client_download_config_specs"],
* });
* const consoleKey = new statsig.Keys("console_key", {
* description: "A short description of what this console key is used for.",
* type: "CONSOLE",
* scopes: ["omni_read_only"],
* });
* ```
*/
export declare class Keys extends pulumi.CustomResource {
/**
* Get an existing Keys 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?: KeysState, opts?: pulumi.CustomResourceOptions): Keys;
/**
* Returns true if the given object is an instance of Keys. 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 Keys;
readonly description: pulumi.Output<string>;
readonly environments: pulumi.Output<string[]>;
readonly key: pulumi.Output<string>;
readonly scopes: pulumi.Output<string[]>;
readonly secondaryTargetAppIds: pulumi.Output<string[]>;
readonly targetAppId: pulumi.Output<string>;
readonly type: pulumi.Output<string>;
/**
* Create a Keys 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: KeysArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Keys resources.
*/
export interface KeysState {
description?: pulumi.Input<string>;
environments?: pulumi.Input<pulumi.Input<string>[]>;
key?: pulumi.Input<string>;
scopes?: pulumi.Input<pulumi.Input<string>[]>;
secondaryTargetAppIds?: pulumi.Input<pulumi.Input<string>[]>;
targetAppId?: pulumi.Input<string>;
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Keys resource.
*/
export interface KeysArgs {
description: pulumi.Input<string>;
environments?: pulumi.Input<pulumi.Input<string>[]>;
key?: pulumi.Input<string>;
scopes?: pulumi.Input<pulumi.Input<string>[]>;
secondaryTargetAppIds?: pulumi.Input<pulumi.Input<string>[]>;
targetAppId?: pulumi.Input<string>;
type: pulumi.Input<string>;
}