@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
214 lines (213 loc) • 5.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for creating a Harness DBDevOps Instance.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const test = new harness.platform.DbInstance("test", {
* identifier: "identifier",
* orgId: "org_id",
* projectId: "project_id",
* name: "name",
* tags: [
* "foo:bar",
* "bar:foo",
* ],
* schema: "schema1",
* branch: "main",
* connector: "jdbcConnector",
* context: "ctx",
* liquibaseSubstituteProperties: {
* key1: "value1",
* key2: "value2",
* },
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import project level db instance
*
* ```sh
* $ pulumi import harness:platform/dbInstance:DbInstance example <org_id>/<project_id>/<db_schema_id>/<db_instance_id>
* ```
*/
export declare class DbInstance extends pulumi.CustomResource {
/**
* Get an existing DbInstance 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?: DbInstanceState, opts?: pulumi.CustomResourceOptions): DbInstance;
/**
* Returns true if the given object is an instance of DbInstance. 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 DbInstance;
/**
* The branch of changeSet repository
*/
readonly branch: pulumi.Output<string | undefined>;
/**
* The connector to database
*/
readonly connector: pulumi.Output<string>;
/**
* The liquibase context
*/
readonly context: pulumi.Output<string | undefined>;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* The properties to substitute in liquibase changelog
*/
readonly liquibaseSubstituteProperties: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string>;
/**
* The identifier of the parent database schema
*/
readonly schema: pulumi.Output<string>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a DbInstance 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: DbInstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DbInstance resources.
*/
export interface DbInstanceState {
/**
* The branch of changeSet repository
*/
branch?: pulumi.Input<string>;
/**
* The connector to database
*/
connector?: pulumi.Input<string>;
/**
* The liquibase context
*/
context?: pulumi.Input<string>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: pulumi.Input<string>;
/**
* The properties to substitute in liquibase changelog
*/
liquibaseSubstituteProperties?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The identifier of the parent database schema
*/
schema?: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a DbInstance resource.
*/
export interface DbInstanceArgs {
/**
* The branch of changeSet repository
*/
branch?: pulumi.Input<string>;
/**
* The connector to database
*/
connector: pulumi.Input<string>;
/**
* The liquibase context
*/
context?: pulumi.Input<string>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: pulumi.Input<string>;
/**
* The properties to substitute in liquibase changelog
*/
liquibaseSubstituteProperties?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId: pulumi.Input<string>;
/**
* The identifier of the parent database schema
*/
schema: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}