@osmit-gmbh/pulumi-authentik
Version:
A Pulumi package for creating and managing authentik cloud resources.
100 lines (99 loc) • 4.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as authentik from "@osmit-gmbh/pulumi-authentik";
*
* // Create a prompt field
* const field = new authentik.StagePromptField("field", {
* fieldKey: "username",
* label: "Username",
* type: "username",
* });
* ```
*/
export declare class StagePromptField extends pulumi.CustomResource {
/**
* Get an existing StagePromptField 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?: StagePromptFieldState, opts?: pulumi.CustomResourceOptions): StagePromptField;
/**
* Returns true if the given object is an instance of StagePromptField. 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 StagePromptField;
readonly fieldKey: pulumi.Output<string>;
readonly initialValue: pulumi.Output<string | undefined>;
readonly initialValueExpression: pulumi.Output<boolean | undefined>;
readonly label: pulumi.Output<string>;
readonly name: pulumi.Output<string>;
readonly order: pulumi.Output<number | undefined>;
readonly placeholder: pulumi.Output<string | undefined>;
readonly placeholderExpression: pulumi.Output<boolean | undefined>;
readonly required: pulumi.Output<boolean | undefined>;
readonly subText: pulumi.Output<string | undefined>;
/**
* Allowed values: - `text` - `textArea` - `textReadOnly` - `textAreaReadOnly` - `username` - `email` - `password` -
* `number` - `checkbox` - `radio-button-group` - `dropdown` - `date` - `date-time` - `file` - `separator` - `hidden` -
* `static` - `ak-locale`
*/
readonly type: pulumi.Output<string>;
/**
* Create a StagePromptField 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: StagePromptFieldArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StagePromptField resources.
*/
export interface StagePromptFieldState {
fieldKey?: pulumi.Input<string>;
initialValue?: pulumi.Input<string>;
initialValueExpression?: pulumi.Input<boolean>;
label?: pulumi.Input<string>;
name?: pulumi.Input<string>;
order?: pulumi.Input<number>;
placeholder?: pulumi.Input<string>;
placeholderExpression?: pulumi.Input<boolean>;
required?: pulumi.Input<boolean>;
subText?: pulumi.Input<string>;
/**
* Allowed values: - `text` - `textArea` - `textReadOnly` - `textAreaReadOnly` - `username` - `email` - `password` -
* `number` - `checkbox` - `radio-button-group` - `dropdown` - `date` - `date-time` - `file` - `separator` - `hidden` -
* `static` - `ak-locale`
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StagePromptField resource.
*/
export interface StagePromptFieldArgs {
fieldKey: pulumi.Input<string>;
initialValue?: pulumi.Input<string>;
initialValueExpression?: pulumi.Input<boolean>;
label: pulumi.Input<string>;
name?: pulumi.Input<string>;
order?: pulumi.Input<number>;
placeholder?: pulumi.Input<string>;
placeholderExpression?: pulumi.Input<boolean>;
required?: pulumi.Input<boolean>;
subText?: pulumi.Input<string>;
/**
* Allowed values: - `text` - `textArea` - `textReadOnly` - `textAreaReadOnly` - `username` - `email` - `password` -
* `number` - `checkbox` - `radio-button-group` - `dropdown` - `date` - `date-time` - `file` - `separator` - `hidden` -
* `static` - `ak-locale`
*/
type: pulumi.Input<string>;
}