pulumi-fusionauth
Version:
A Pulumi package for managing FusionAuth instances.
230 lines (229 loc) • 8.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## # User Action Resource
*
* [User Actions API](https://fusionauth.io/docs/v1/tech/apis/user-actions/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "pulumi-fusionauth";
*
* const example = new fusionauth.FusionAuthUserAction("example", {
* preventLogin: true,
* temporal: true,
* });
* ```
*/
export declare class FusionAuthUserAction extends pulumi.CustomResource {
/**
* Get an existing FusionAuthUserAction 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?: FusionAuthUserActionState, opts?: pulumi.CustomResourceOptions): FusionAuthUserAction;
/**
* Returns true if the given object is an instance of FusionAuthUserAction. 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 FusionAuthUserAction;
/**
* The Id of the Email Template that is used when User Actions are canceled.
*/
readonly cancelEmailTemplateId: pulumi.Output<string | undefined>;
/**
* The Id of the Email Template that is used when User Actions expired automatically (end).
*/
readonly endEmailTemplateId: pulumi.Output<string | undefined>;
/**
* Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
*/
readonly includeEmailInEventJson: pulumi.Output<boolean | undefined>;
/**
* A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
*/
readonly localizedNames: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Id of the Email Template that is used when User Actions are modified.
*/
readonly modifyEmailTemplateId: pulumi.Output<string | undefined>;
/**
* The name of this User Action.
*/
readonly name: pulumi.Output<string>;
/**
* The list of User Action Options.
*/
readonly options: pulumi.Output<outputs.FusionAuthUserActionOption[] | undefined>;
/**
* Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See `temporal`.
*/
readonly preventLogin: pulumi.Output<boolean | undefined>;
/**
* Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
*/
readonly sendEndEvent: pulumi.Output<boolean | undefined>;
/**
* The Id of the Email Template that is used when User Actions are started (created).
*/
readonly startEmailTemplateId: pulumi.Output<string | undefined>;
/**
* Whether or not this User Action is time-based (temporal).
*/
readonly temporal: pulumi.Output<boolean | undefined>;
/**
* The id of this User Action.
*/
readonly userActionId: pulumi.Output<string>;
/**
* Whether or not email is enabled for this User Action.
*/
readonly userEmailingEnabled: pulumi.Output<boolean | undefined>;
/**
* Whether or not user notifications are enabled for this User Action.
*/
readonly userNotificationsEnabled: pulumi.Output<boolean | undefined>;
/**
* Create a FusionAuthUserAction 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?: FusionAuthUserActionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FusionAuthUserAction resources.
*/
export interface FusionAuthUserActionState {
/**
* The Id of the Email Template that is used when User Actions are canceled.
*/
cancelEmailTemplateId?: pulumi.Input<string>;
/**
* The Id of the Email Template that is used when User Actions expired automatically (end).
*/
endEmailTemplateId?: pulumi.Input<string>;
/**
* Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
*/
includeEmailInEventJson?: pulumi.Input<boolean>;
/**
* A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
*/
localizedNames?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Id of the Email Template that is used when User Actions are modified.
*/
modifyEmailTemplateId?: pulumi.Input<string>;
/**
* The name of this User Action.
*/
name?: pulumi.Input<string>;
/**
* The list of User Action Options.
*/
options?: pulumi.Input<pulumi.Input<inputs.FusionAuthUserActionOption>[]>;
/**
* Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See `temporal`.
*/
preventLogin?: pulumi.Input<boolean>;
/**
* Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
*/
sendEndEvent?: pulumi.Input<boolean>;
/**
* The Id of the Email Template that is used when User Actions are started (created).
*/
startEmailTemplateId?: pulumi.Input<string>;
/**
* Whether or not this User Action is time-based (temporal).
*/
temporal?: pulumi.Input<boolean>;
/**
* The id of this User Action.
*/
userActionId?: pulumi.Input<string>;
/**
* Whether or not email is enabled for this User Action.
*/
userEmailingEnabled?: pulumi.Input<boolean>;
/**
* Whether or not user notifications are enabled for this User Action.
*/
userNotificationsEnabled?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a FusionAuthUserAction resource.
*/
export interface FusionAuthUserActionArgs {
/**
* The Id of the Email Template that is used when User Actions are canceled.
*/
cancelEmailTemplateId?: pulumi.Input<string>;
/**
* The Id of the Email Template that is used when User Actions expired automatically (end).
*/
endEmailTemplateId?: pulumi.Input<string>;
/**
* Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
*/
includeEmailInEventJson?: pulumi.Input<boolean>;
/**
* A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
*/
localizedNames?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Id of the Email Template that is used when User Actions are modified.
*/
modifyEmailTemplateId?: pulumi.Input<string>;
/**
* The name of this User Action.
*/
name?: pulumi.Input<string>;
/**
* The list of User Action Options.
*/
options?: pulumi.Input<pulumi.Input<inputs.FusionAuthUserActionOption>[]>;
/**
* Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See `temporal`.
*/
preventLogin?: pulumi.Input<boolean>;
/**
* Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
*/
sendEndEvent?: pulumi.Input<boolean>;
/**
* The Id of the Email Template that is used when User Actions are started (created).
*/
startEmailTemplateId?: pulumi.Input<string>;
/**
* Whether or not this User Action is time-based (temporal).
*/
temporal?: pulumi.Input<boolean>;
/**
* The id of this User Action.
*/
userActionId?: pulumi.Input<string>;
/**
* Whether or not email is enabled for this User Action.
*/
userEmailingEnabled?: pulumi.Input<boolean>;
/**
* Whether or not user notifications are enabled for this User Action.
*/
userNotificationsEnabled?: pulumi.Input<boolean>;
}