@ctfer-io/pulumi-ctfd
Version:
The CTFd provider for Pulumi, to manage its resources as code.
68 lines (67 loc) • 3.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the ctfd 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;
/**
* User API key. Could use `CTFD_API_KEY` environment variable instead. Despite being the most convenient way to
* authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation
* policy.
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* The administrator or service account password to login with. Could use `CTFD_ADMIN_PASSWORD` environment variable
* instead.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* CTFd base URL (e.g. `https://my-ctf.lan`). Could use `CTFD_URL` environment variable instead.
*/
readonly url: pulumi.Output<string | undefined>;
/**
* The administrator or service account username to login with. Could use `CTFD_ADMIN_USERNAME` environment variable
* instead.
*/
readonly username: 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 {
/**
* User API key. Could use `CTFD_API_KEY` environment variable instead. Despite being the most convenient way to
* authenticate yourself, we do not recommend it as you will probably generate a long-live token without any rotation
* policy.
*/
apiKey?: pulumi.Input<string>;
/**
* The administrator or service account password to login with. Could use `CTFD_ADMIN_PASSWORD` environment variable
* instead.
*/
password?: pulumi.Input<string>;
/**
* CTFd base URL (e.g. `https://my-ctf.lan`). Could use `CTFD_URL` environment variable instead.
*/
url?: pulumi.Input<string>;
/**
* The administrator or service account username to login with. Could use `CTFD_ADMIN_USERNAME` environment variable
* instead.
*/
username?: pulumi.Input<string>;
}