@formalco/pulumi/resource.d.ts

A Pulumi package for creating and managing Formal resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Registering a Resource with Formal.
 */
export declare class Resource extends pulumi.CustomResource {
    /**
     * Get an existing Resource 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?: ResourceState, opts?: pulumi.CustomResourceOptions): Resource;
    /**
     * Returns true if the given object is an instance of Resource.  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 Resource;
    /**
     * Creation time of the Resource.
     */
    readonly createdAt: pulumi.Output<number>;
    /**
     * Environment for the Resource, options: DEV, TEST, QA, UAT, EI, PRE, STG, NON_PROD, PROD, CORP.
     *
     * @deprecated This field is deprecated and will be removed in a future release.
     */
    readonly environment: pulumi.Output<string | undefined>;
    /**
     * Hostname of the Resource.
     */
    readonly hostname: pulumi.Output<string>;
    /**
     * Friendly name for the Resource.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The port your Resource is listening on.
     */
    readonly port: pulumi.Output<number>;
    /**
     * The ID of the Space to create the Resource in.
     */
    readonly spaceId: pulumi.Output<string | undefined>;
    /**
     * Technology of the Resource: supported values are `snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http`, `clickhouse`, `redis` and `ssh`.
     */
    readonly technology: pulumi.Output<string>;
    /**
     * For SSH resources, if the backend connection is SSM, supported values are `aws-ec2`, and `aws-ecs`
     */
    readonly technologyProvider: pulumi.Output<string | undefined>;
    /**
     * If set to true, the Resource cannot be deleted.
     */
    readonly terminationProtection: pulumi.Output<boolean | undefined>;
    /**
     * Create a Resource 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: ResourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Resource resources.
 */
export interface ResourceState {
    /**
     * Creation time of the Resource.
     */
    createdAt?: pulumi.Input<number>;
    /**
     * Environment for the Resource, options: DEV, TEST, QA, UAT, EI, PRE, STG, NON_PROD, PROD, CORP.
     *
     * @deprecated This field is deprecated and will be removed in a future release.
     */
    environment?: pulumi.Input<string>;
    /**
     * Hostname of the Resource.
     */
    hostname?: pulumi.Input<string>;
    /**
     * Friendly name for the Resource.
     */
    name?: pulumi.Input<string>;
    /**
     * The port your Resource is listening on.
     */
    port?: pulumi.Input<number>;
    /**
     * The ID of the Space to create the Resource in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * Technology of the Resource: supported values are `snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http`, `clickhouse`, `redis` and `ssh`.
     */
    technology?: pulumi.Input<string>;
    /**
     * For SSH resources, if the backend connection is SSM, supported values are `aws-ec2`, and `aws-ecs`
     */
    technologyProvider?: pulumi.Input<string>;
    /**
     * If set to true, the Resource cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a Resource resource.
 */
export interface ResourceArgs {
    /**
     * Environment for the Resource, options: DEV, TEST, QA, UAT, EI, PRE, STG, NON_PROD, PROD, CORP.
     *
     * @deprecated This field is deprecated and will be removed in a future release.
     */
    environment?: pulumi.Input<string>;
    /**
     * Hostname of the Resource.
     */
    hostname: pulumi.Input<string>;
    /**
     * Friendly name for the Resource.
     */
    name?: pulumi.Input<string>;
    /**
     * The port your Resource is listening on.
     */
    port: pulumi.Input<number>;
    /**
     * The ID of the Space to create the Resource in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * Technology of the Resource: supported values are `snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http`, `clickhouse`, `redis` and `ssh`.
     */
    technology: pulumi.Input<string>;
    /**
     * For SSH resources, if the backend connection is SSM, supported values are `aws-ec2`, and `aws-ecs`
     */
    technologyProvider?: pulumi.Input<string>;
    /**
     * If set to true, the Resource cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}