@lbrlabs/pulumi-harness
Version:
A Pulumi package for creating and managing Harness resources.
192 lines (191 loc) • 5.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating a Harness Gitops Agents.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@lbrlabs/pulumi-harness";
*
* const example = new harness.platform.GitOpsAgent("example", {
* accountId: "account_id",
* identifier: "identifier",
* metadatas: [{
* highAvailability: true,
* namespace: "namespace",
* }],
* orgId: "org_id",
* projectId: "project_id",
* type: "MANAGED_ARGO_PROVIDER",
* });
* ```
*
* ## Import
*
* Import a Account level Gitops Agent
*
* ```sh
* $ pulumi import harness:platform/gitOpsAgent:GitOpsAgent example <agent_id>
* ```
*
* Import a Project level Gitops Agent
*
* ```sh
* $ pulumi import harness:platform/gitOpsAgent:GitOpsAgent example <organization_id>/<project_id>/<agent_id>
* ```
*/
export declare class GitOpsAgent extends pulumi.CustomResource {
/**
* Get an existing GitOpsAgent 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?: GitOpsAgentState, opts?: pulumi.CustomResourceOptions): GitOpsAgent;
/**
* Returns true if the given object is an instance of GitOpsAgent. 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 GitOpsAgent;
/**
* Account identifier of the GitOps agent.
*/
readonly accountId: pulumi.Output<string>;
/**
* Description of the GitOps agent.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Identifier of the GitOps agent.
*/
readonly identifier: pulumi.Output<string>;
/**
* Metadata of the agent.
*/
readonly metadatas: pulumi.Output<outputs.platform.GitOpsAgentMetadata[] | undefined>;
/**
* Name of the GitOps agent.
*/
readonly name: pulumi.Output<string>;
/**
* Organization identifier of the GitOps agent.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Project identifier of the GitOps agent.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Default: "AGENT*TYPE*UNSET"
* Enum: "AGENT*TYPE*UNSET" "CONNECTED*ARGO*PROVIDER" "MANAGED*ARGO*PROVIDER"
*/
readonly type: pulumi.Output<string>;
/**
* Create a GitOpsAgent 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: GitOpsAgentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GitOpsAgent resources.
*/
export interface GitOpsAgentState {
/**
* Account identifier of the GitOps agent.
*/
accountId?: pulumi.Input<string>;
/**
* Description of the GitOps agent.
*/
description?: pulumi.Input<string>;
/**
* Identifier of the GitOps agent.
*/
identifier?: pulumi.Input<string>;
/**
* Metadata of the agent.
*/
metadatas?: pulumi.Input<pulumi.Input<inputs.platform.GitOpsAgentMetadata>[]>;
/**
* Name of the GitOps agent.
*/
name?: pulumi.Input<string>;
/**
* Organization identifier of the GitOps agent.
*/
orgId?: pulumi.Input<string>;
/**
* Project identifier of the GitOps agent.
*/
projectId?: pulumi.Input<string>;
/**
* Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Default: "AGENT*TYPE*UNSET"
* Enum: "AGENT*TYPE*UNSET" "CONNECTED*ARGO*PROVIDER" "MANAGED*ARGO*PROVIDER"
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a GitOpsAgent resource.
*/
export interface GitOpsAgentArgs {
/**
* Account identifier of the GitOps agent.
*/
accountId: pulumi.Input<string>;
/**
* Description of the GitOps agent.
*/
description?: pulumi.Input<string>;
/**
* Identifier of the GitOps agent.
*/
identifier: pulumi.Input<string>;
/**
* Metadata of the agent.
*/
metadatas?: pulumi.Input<pulumi.Input<inputs.platform.GitOpsAgentMetadata>[]>;
/**
* Name of the GitOps agent.
*/
name?: pulumi.Input<string>;
/**
* Organization identifier of the GitOps agent.
*/
orgId?: pulumi.Input<string>;
/**
* Project identifier of the GitOps agent.
*/
projectId?: pulumi.Input<string>;
/**
* Tags for the GitOps agents. These can be used to search or filter the GitOps agents.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Default: "AGENT*TYPE*UNSET"
* Enum: "AGENT*TYPE*UNSET" "CONNECTED*ARGO*PROVIDER" "MANAGED*ARGO*PROVIDER"
*/
type: pulumi.Input<string>;
}