pulumi-fusionauth
Version:
A Pulumi package for managing FusionAuth instances.
200 lines (199 loc) • 7.81 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # Generic Connector Resource
*
* A FusionAuth Generic Connector is a named object that provides configuration for allowing authentication against external systems.
*
* [Generic Connector API](https://fusionauth.io/docs/v1/tech/apis/connectors/generic/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "pulumi-fusionauth";
*
* const example = new fusionauth.FusionAuthGenericConnector("example", {
* authenticationUrl: "http://mygameserver.local:7001/fusionauth-connector",
* connectTimeout: 1000,
* data: {
* foo: "bar",
* },
* debug: false,
* headers: {
* foo: "bar",
* bar: "baz",
* },
* httpAuthenticationPassword: "supersecret",
* httpAuthenticationUsername: "me",
* readTimeout: 2000,
* sslCertificateKeyId: "00000000-0000-0000-0000-000000000678",
* });
* ```
*/
export declare class FusionAuthGenericConnector extends pulumi.CustomResource {
/**
* Get an existing FusionAuthGenericConnector 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?: FusionAuthGenericConnectorState, opts?: pulumi.CustomResourceOptions): FusionAuthGenericConnector;
/**
* Returns true if the given object is an instance of FusionAuthGenericConnector. 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 FusionAuthGenericConnector;
/**
* The fully qualified URL used to send an HTTP request to authenticate the user.
*/
readonly authenticationUrl: pulumi.Output<string>;
/**
* The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
*/
readonly connectTimeout: pulumi.Output<number>;
/**
* An object that can hold any information about the Connector that should be persisted.
*/
readonly data: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
*/
readonly debug: pulumi.Output<boolean | undefined>;
/**
* An object that can hold HTTPHeader key and value pairs.
*/
readonly headers: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The HTTP basic authentication password that is sent as part of the HTTP request for the events.
*/
readonly httpAuthenticationPassword: pulumi.Output<string | undefined>;
/**
* The HTTP basic authentication username that is sent as part of the HTTP request for the events.
*/
readonly httpAuthenticationUsername: pulumi.Output<string | undefined>;
/**
* The unique Connector name.
*/
readonly name: pulumi.Output<string>;
/**
* The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
*/
readonly readTimeout: pulumi.Output<number>;
/**
* The Id of an existing [Key](https://fusionauth.io/docs/v1/tech/apis/keys/). The X509 certificate is used for client certificate authentication in requests to the Connector.
*/
readonly sslCertificateKeyId: pulumi.Output<string | undefined>;
/**
* Create a FusionAuthGenericConnector 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: FusionAuthGenericConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FusionAuthGenericConnector resources.
*/
export interface FusionAuthGenericConnectorState {
/**
* The fully qualified URL used to send an HTTP request to authenticate the user.
*/
authenticationUrl?: pulumi.Input<string>;
/**
* The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
*/
connectTimeout?: pulumi.Input<number>;
/**
* An object that can hold any information about the Connector that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
*/
debug?: pulumi.Input<boolean>;
/**
* An object that can hold HTTPHeader key and value pairs.
*/
headers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The HTTP basic authentication password that is sent as part of the HTTP request for the events.
*/
httpAuthenticationPassword?: pulumi.Input<string>;
/**
* The HTTP basic authentication username that is sent as part of the HTTP request for the events.
*/
httpAuthenticationUsername?: pulumi.Input<string>;
/**
* The unique Connector name.
*/
name?: pulumi.Input<string>;
/**
* The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
*/
readTimeout?: pulumi.Input<number>;
/**
* The Id of an existing [Key](https://fusionauth.io/docs/v1/tech/apis/keys/). The X509 certificate is used for client certificate authentication in requests to the Connector.
*/
sslCertificateKeyId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FusionAuthGenericConnector resource.
*/
export interface FusionAuthGenericConnectorArgs {
/**
* The fully qualified URL used to send an HTTP request to authenticate the user.
*/
authenticationUrl: pulumi.Input<string>;
/**
* The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
*/
connectTimeout: pulumi.Input<number>;
/**
* An object that can hold any information about the Connector that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Determines if debug should be enabled to create an event log to assist in debugging integration errors. Defaults to false.
*/
debug?: pulumi.Input<boolean>;
/**
* An object that can hold HTTPHeader key and value pairs.
*/
headers?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The HTTP basic authentication password that is sent as part of the HTTP request for the events.
*/
httpAuthenticationPassword?: pulumi.Input<string>;
/**
* The HTTP basic authentication username that is sent as part of the HTTP request for the events.
*/
httpAuthenticationUsername?: pulumi.Input<string>;
/**
* The unique Connector name.
*/
name?: pulumi.Input<string>;
/**
* The read timeout in milliseconds used when FusionAuth sends events to the Webhook.
*/
readTimeout: pulumi.Input<number>;
/**
* The Id of an existing [Key](https://fusionauth.io/docs/v1/tech/apis/keys/). The X509 certificate is used for client certificate authentication in requests to the Connector.
*/
sslCertificateKeyId?: pulumi.Input<string>;
}