@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
50 lines (49 loc) • 2.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the cockroach package. By default, resources use package-wide configuration
* settings, however an explicit `Provider` instance may be created and passed during resource
* construction to achieve fine-grained programmatic control over provider settings. See the
* [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
*/
export declare class Provider extends pulumi.ProviderResource {
/**
* Returns true if the given object is an instance of Provider. 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 Provider;
/**
* The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the
* organization is required and can be provided using the `COCKROACH_VANITY_NAME` environment variable. If the JWT is
* mapped to multiple identities, the identity to impersonate should be provided using the `COCKROACH_USERNAME` environment
* variable, and should contain either a user email address or a service account ID.
*/
readonly apijwt: pulumi.Output<string | undefined>;
/**
* The API key to access CockroachDB Cloud. If this field is provided, it is used and `apijwt` is ignored.
*/
readonly apikey: pulumi.Output<string | undefined>;
/**
* Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions);
}
/**
* The set of arguments for constructing a Provider resource.
*/
export interface ProviderArgs {
/**
* The JWT from a JWT Issuer configured for the CockroachDB Cloud Organization. In this case, the vanity name of the
* organization is required and can be provided using the `COCKROACH_VANITY_NAME` environment variable. If the JWT is
* mapped to multiple identities, the identity to impersonate should be provided using the `COCKROACH_USERNAME` environment
* variable, and should contain either a user email address or a service account ID.
*/
apijwt?: pulumi.Input<string>;
/**
* The API key to access CockroachDB Cloud. If this field is provided, it is used and `apijwt` is ignored.
*/
apikey?: pulumi.Input<string>;
}