@osmit-gmbh/pulumi-authentik
Version:
A Pulumi package for creating and managing authentik cloud resources.
171 lines (170 loc) • 5.08 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 email stage for email verification, uses global settings by default
* const name = new authentik.StageEmail("name", {name: "email-verification"});
* ```
*/
export declare class StageEmail extends pulumi.CustomResource {
/**
* Get an existing StageEmail 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?: StageEmailState, opts?: pulumi.CustomResourceOptions): StageEmail;
/**
* Returns true if the given object is an instance of StageEmail. 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 StageEmail;
/**
* Defaults to `false`.
*/
readonly activateUserOnSuccess: pulumi.Output<boolean | undefined>;
/**
* Defaults to `system@authentik.local`.
*/
readonly fromAddress: pulumi.Output<string | undefined>;
/**
* Defaults to `localhost`.
*/
readonly host: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly password: pulumi.Output<string | undefined>;
/**
* Defaults to `25`.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* Defaults to `authentik`.
*/
readonly subject: pulumi.Output<string | undefined>;
/**
* Defaults to `email/password_reset.html`.
*/
readonly template: pulumi.Output<string | undefined>;
/**
* Defaults to `30`.
*/
readonly timeout: pulumi.Output<number | undefined>;
/**
* Defaults to `30`.
*/
readonly tokenExpiry: pulumi.Output<number | undefined>;
/**
* Defaults to `true`.
*/
readonly useGlobalSettings: pulumi.Output<boolean | undefined>;
readonly useSsl: pulumi.Output<boolean | undefined>;
readonly useTls: pulumi.Output<boolean | undefined>;
readonly username: pulumi.Output<string | undefined>;
/**
* Create a StageEmail 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?: StageEmailArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StageEmail resources.
*/
export interface StageEmailState {
/**
* Defaults to `false`.
*/
activateUserOnSuccess?: pulumi.Input<boolean>;
/**
* Defaults to `system@authentik.local`.
*/
fromAddress?: pulumi.Input<string>;
/**
* Defaults to `localhost`.
*/
host?: pulumi.Input<string>;
name?: pulumi.Input<string>;
password?: pulumi.Input<string>;
/**
* Defaults to `25`.
*/
port?: pulumi.Input<number>;
/**
* Defaults to `authentik`.
*/
subject?: pulumi.Input<string>;
/**
* Defaults to `email/password_reset.html`.
*/
template?: pulumi.Input<string>;
/**
* Defaults to `30`.
*/
timeout?: pulumi.Input<number>;
/**
* Defaults to `30`.
*/
tokenExpiry?: pulumi.Input<number>;
/**
* Defaults to `true`.
*/
useGlobalSettings?: pulumi.Input<boolean>;
useSsl?: pulumi.Input<boolean>;
useTls?: pulumi.Input<boolean>;
username?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StageEmail resource.
*/
export interface StageEmailArgs {
/**
* Defaults to `false`.
*/
activateUserOnSuccess?: pulumi.Input<boolean>;
/**
* Defaults to `system@authentik.local`.
*/
fromAddress?: pulumi.Input<string>;
/**
* Defaults to `localhost`.
*/
host?: pulumi.Input<string>;
name?: pulumi.Input<string>;
password?: pulumi.Input<string>;
/**
* Defaults to `25`.
*/
port?: pulumi.Input<number>;
/**
* Defaults to `authentik`.
*/
subject?: pulumi.Input<string>;
/**
* Defaults to `email/password_reset.html`.
*/
template?: pulumi.Input<string>;
/**
* Defaults to `30`.
*/
timeout?: pulumi.Input<number>;
/**
* Defaults to `30`.
*/
tokenExpiry?: pulumi.Input<number>;
/**
* Defaults to `true`.
*/
useGlobalSettings?: pulumi.Input<boolean>;
useSsl?: pulumi.Input<boolean>;
useTls?: pulumi.Input<boolean>;
username?: pulumi.Input<string>;
}