@formalco/pulumi/connector.d.ts

A Pulumi package for creating and managing Formal resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Registering a Connector with Formal.
 */
export declare class Connector extends pulumi.CustomResource {
    /**
     * Get an existing Connector 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?: ConnectorState, opts?: pulumi.CustomResourceOptions): Connector;
    /**
     * Returns true if the given object is an instance of Connector.  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 Connector;
    /**
     * Api key for the deployed Connector.
     */
    readonly apiKey: pulumi.Output<string>;
    /**
     * Friendly name for this Connector.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the Space to create the Connector in.
     */
    readonly spaceId: pulumi.Output<string | undefined>;
    /**
     * If set to true, this Connector cannot be deleted.
     */
    readonly terminationProtection: pulumi.Output<boolean | undefined>;
    /**
     * Create a Connector 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?: ConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Connector resources.
 */
export interface ConnectorState {
    /**
     * Api key for the deployed Connector.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Friendly name for this Connector.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Space to create the Connector in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * If set to true, this Connector cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Connector resource.
 */
export interface ConnectorArgs {
    /**
     * Friendly name for this Connector.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Space to create the Connector in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * If set to true, this Connector cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}