@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
90 lines (89 loc) • 2.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cockroach from "@pulumiverse/cockroach";
*
* const example = new cockroach.ApiKey("example", {
* name: "An example api key",
* serviceAccountId: exampleSa.id,
* });
* export const exampleSecret = example.secret;
* ```
*
* ## Import
*
* Since the secret, is not retreivable after creation, it must be provided
*
* during import. The API key ID can be derived from the secret.
*
* ```sh
* $ pulumi import cockroach:index/apiKey:ApiKey format: <resource> <api key secret>
* ```
*
* ```sh
* $ pulumi import cockroach:index/apiKey:ApiKey example CCDB1_D4zMI3pZTmk5rGrzYqMhbc_NkcXLI8d81Mtx3djD45iwPfgtnaRv0XCh0Z9047K
* ```
*/
export declare class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey 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?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey;
/**
* Returns true if the given object is an instance of ApiKey. 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 ApiKey;
/**
* Creation time of the api key.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Name of the api key.
*/
readonly name: pulumi.Output<string>;
readonly secret: pulumi.Output<string>;
readonly serviceAccountId: pulumi.Output<string>;
/**
* Create a ApiKey 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: ApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
/**
* Creation time of the api key.
*/
createdAt?: pulumi.Input<string>;
/**
* Name of the api key.
*/
name?: pulumi.Input<string>;
secret?: pulumi.Input<string>;
serviceAccountId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
/**
* Name of the api key.
*/
name?: pulumi.Input<string>;
serviceAccountId: pulumi.Input<string>;
}