@lbrlabs/pulumi-harness
Version:
A Pulumi package for creating and managing Harness resources.
203 lines (202 loc) • 6.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating a Docker connector.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@lbrlabs/pulumi-harness";
*
* // credentials username password
* const test = new harness.platform.DockerConnector("test", {
* credentials: {
* passwordRef: "account.secret_id",
* username: "admin",
* },
* delegateSelectors: ["harness-delegate"],
* description: "test",
* identifier: "identifer",
* tags: ["foo:bar"],
* type: "DockerHub",
* url: "https://hub.docker.com",
* });
* ```
*
* ## Import
*
* Import account level docker connector
*
* ```sh
* $ pulumi import harness:platform/dockerConnector:DockerConnector example <connector_id>
* ```
*
* Import org level docker connector
*
* ```sh
* $ pulumi import harness:platform/dockerConnector:DockerConnector example <ord_id>/<connector_id>
* ```
*
* Import project level docker connector
*
* ```sh
* $ pulumi import harness:platform/dockerConnector:DockerConnector example <org_id>/<project_id>/<connector_id>
* ```
*/
export declare class DockerConnector extends pulumi.CustomResource {
/**
* Get an existing DockerConnector 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?: DockerConnectorState, opts?: pulumi.CustomResourceOptions): DockerConnector;
/**
* Returns true if the given object is an instance of DockerConnector. 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 DockerConnector;
/**
* The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
*/
readonly credentials: pulumi.Output<outputs.platform.DockerConnectorCredentials | undefined>;
/**
* Tags to filter delegates for connection.
*/
readonly delegateSelectors: pulumi.Output<string[] | undefined>;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
*/
readonly type: pulumi.Output<string>;
/**
* The URL of the docker registry.
*/
readonly url: pulumi.Output<string>;
/**
* Create a DockerConnector 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: DockerConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DockerConnector resources.
*/
export interface DockerConnectorState {
/**
* The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
*/
credentials?: pulumi.Input<inputs.platform.DockerConnectorCredentials>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: 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>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
*/
type?: pulumi.Input<string>;
/**
* The URL of the docker registry.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DockerConnector resource.
*/
export interface DockerConnectorArgs {
/**
* The credentials to use for the docker registry. If not specified then the connection is made to the registry anonymously.
*/
credentials?: pulumi.Input<inputs.platform.DockerConnectorCredentials>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: 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>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of the docker registry. Valid options are DockerHub, Harbor, Other, Quay
*/
type: pulumi.Input<string>;
/**
* The URL of the docker registry.
*/
url: pulumi.Input<string>;
}