@formalco/pulumi
Version:
A Pulumi package for creating and managing Formal resources.
124 lines (123 loc) • 4.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Registering a Sidecar with Formal.
*/
export declare class Sidecar extends pulumi.CustomResource {
/**
* Get an existing Sidecar 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?: SidecarState, opts?: pulumi.CustomResourceOptions): Sidecar;
/**
* Returns true if the given object is an instance of Sidecar. 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 Sidecar;
/**
* Api key for the deployed Sidecar.
*/
readonly apiKey: pulumi.Output<string>;
/**
* Creation time of the sidecar.
*/
readonly createdAt: pulumi.Output<number>;
/**
* If deploymentType is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
*/
readonly formalControlPlaneTlsCertificate: pulumi.Output<string>;
/**
* The hostname of the created sidecar.
*/
readonly hostname: pulumi.Output<string>;
/**
* Friendly name for this Sidecar.
*/
readonly name: pulumi.Output<string>;
/**
* Technology of the Datastore: supported values are`snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http` and `ssh`.
*/
readonly technology: pulumi.Output<string>;
/**
* If set to true, this Sidecar cannot be deleted.
*/
readonly terminationProtection: pulumi.Output<boolean | undefined>;
/**
* Version of the Sidecar to deploy for `managed`.
*/
readonly version: pulumi.Output<string | undefined>;
/**
* Create a Sidecar 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: SidecarArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Sidecar resources.
*/
export interface SidecarState {
/**
* Api key for the deployed Sidecar.
*/
apiKey?: pulumi.Input<string>;
/**
* Creation time of the sidecar.
*/
createdAt?: pulumi.Input<number>;
/**
* If deploymentType is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar.
*/
formalControlPlaneTlsCertificate?: pulumi.Input<string>;
/**
* The hostname of the created sidecar.
*/
hostname?: pulumi.Input<string>;
/**
* Friendly name for this Sidecar.
*/
name?: pulumi.Input<string>;
/**
* Technology of the Datastore: supported values are`snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http` and `ssh`.
*/
technology?: pulumi.Input<string>;
/**
* If set to true, this Sidecar cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* Version of the Sidecar to deploy for `managed`.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Sidecar resource.
*/
export interface SidecarArgs {
/**
* The hostname of the created sidecar.
*/
hostname: pulumi.Input<string>;
/**
* Friendly name for this Sidecar.
*/
name?: pulumi.Input<string>;
/**
* Technology of the Datastore: supported values are`snowflake`, `postgres`, `redshift`, `mysql`, `mariadb`, `s3`, `dynamodb`, `mongodb`, `documentdb`, `http` and `ssh`.
*/
technology: pulumi.Input<string>;
/**
* If set to true, this Sidecar cannot be deleted.
*/
terminationProtection?: pulumi.Input<boolean>;
/**
* Version of the Sidecar to deploy for `managed`.
*/
version?: pulumi.Input<string>;
}