@formalco/pulumi
Version: 
A Pulumi package for creating and managing Formal resources.
108 lines (107 loc) • 4.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
 * Registering a Data Discovery with Formal.
 */
export declare class DataDiscovery extends pulumi.CustomResource {
    /**
     * Get an existing DataDiscovery 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?: DataDiscoveryState, opts?: pulumi.CustomResourceOptions): DataDiscovery;
    /**
     * Returns true if the given object is an instance of DataDiscovery.  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 DataDiscovery;
    /**
     * Creation time of the Data Discovery.
     */
    readonly createdAt: pulumi.Output<number>;
    /**
     * Deletion policy of the Data Discovery. Possible values: `delete`, `markForDeletion`.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * Native user ID linked to this Data Discovery.
     */
    readonly nativeUserId: pulumi.Output<string>;
    /**
     * Path of the inventory object.
     */
    readonly path: pulumi.Output<string | undefined>;
    /**
     * Resource ID linked to this Data Discovery.
     */
    readonly resourceId: pulumi.Output<string>;
    /**
     * Schedule at which the Data Discovery will be executed. Possible values: `6h`, `12h`, `18h`, `24h` or a valid cron expression, for example `0 4,16 * * *` to run daily at 04:00 and 16:00 UTC.
     */
    readonly schedule: pulumi.Output<string>;
    /**
     * Create a DataDiscovery 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: DataDiscoveryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DataDiscovery resources.
 */
export interface DataDiscoveryState {
    /**
     * Creation time of the Data Discovery.
     */
    createdAt?: pulumi.Input<number>;
    /**
     * Deletion policy of the Data Discovery. Possible values: `delete`, `markForDeletion`.
     */
    deletionPolicy?: pulumi.Input<string>;
    /**
     * Native user ID linked to this Data Discovery.
     */
    nativeUserId?: pulumi.Input<string>;
    /**
     * Path of the inventory object.
     */
    path?: pulumi.Input<string>;
    /**
     * Resource ID linked to this Data Discovery.
     */
    resourceId?: pulumi.Input<string>;
    /**
     * Schedule at which the Data Discovery will be executed. Possible values: `6h`, `12h`, `18h`, `24h` or a valid cron expression, for example `0 4,16 * * *` to run daily at 04:00 and 16:00 UTC.
     */
    schedule?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DataDiscovery resource.
 */
export interface DataDiscoveryArgs {
    /**
     * Deletion policy of the Data Discovery. Possible values: `delete`, `markForDeletion`.
     */
    deletionPolicy: pulumi.Input<string>;
    /**
     * Native user ID linked to this Data Discovery.
     */
    nativeUserId: pulumi.Input<string>;
    /**
     * Path of the inventory object.
     */
    path?: pulumi.Input<string>;
    /**
     * Resource ID linked to this Data Discovery.
     */
    resourceId: pulumi.Input<string>;
    /**
     * Schedule at which the Data Discovery will be executed. Possible values: `6h`, `12h`, `18h`, `24h` or a valid cron expression, for example `0 4,16 * * *` to run daily at 04:00 and 16:00 UTC.
     */
    schedule: pulumi.Input<string>;
}