UNPKG

@pulumi/harness

Version:

A Pulumi package for creating and managing Harness resources.

154 lines (153 loc) 5.11 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for mapping environment with Harness Clusters. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as harness from "@pulumi/harness"; * * // mapping a cluster to a project level env * const example = new harness.platform.EnvironmentClustersMapping("example", { * identifier: "mycustomidentifier", * orgId: "orgIdentifer", * projectId: "projectIdentifier", * envId: "exampleEnvId", * clusters: [{ * identifier: "incluster", * name: "in-cluster", * agentIdentifier: "account.gitopsagentdev", * scope: "ACCOUNT", * }], * }); * // mapping two clusters to account level env * const example2 = new harness.platform.EnvironmentClustersMapping("example2", { * identifier: "mycustomidentifier", * envId: "env1", * clusters: [ * { * identifier: "clusterA", * name: "cluster-A", * agentIdentifier: "account.gitopsagentprod", * scope: "ACCOUNT", * }, * { * identifier: "clusterB", * name: "cluster-B", * agentIdentifier: "account.gitopsagentprod", * scope: "ACCOUNT", * }, * ], * }); * ``` * * ## Import * * The `pulumi import` command can be used, for example: */ export declare class EnvironmentClustersMapping extends pulumi.CustomResource { /** * Get an existing EnvironmentClustersMapping 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?: EnvironmentClustersMappingState, opts?: pulumi.CustomResourceOptions): EnvironmentClustersMapping; /** * Returns true if the given object is an instance of EnvironmentClustersMapping. 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 EnvironmentClustersMapping; /** * list of cluster identifiers and names */ readonly clusters: pulumi.Output<outputs.platform.EnvironmentClustersMappingCluster[] | undefined>; /** * environment identifier. */ readonly envId: pulumi.Output<string>; /** * identifier for the cluster mapping(can be given any value). */ readonly identifier: pulumi.Output<string>; /** * org_id of the environment. */ readonly orgId: pulumi.Output<string | undefined>; /** * project_id of the environment. */ readonly projectId: pulumi.Output<string | undefined>; /** * scope at which the environment exists in harness. */ readonly scope: pulumi.Output<string>; /** * Create a EnvironmentClustersMapping 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: EnvironmentClustersMappingArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering EnvironmentClustersMapping resources. */ export interface EnvironmentClustersMappingState { /** * list of cluster identifiers and names */ clusters?: pulumi.Input<pulumi.Input<inputs.platform.EnvironmentClustersMappingCluster>[]>; /** * environment identifier. */ envId?: pulumi.Input<string>; /** * identifier for the cluster mapping(can be given any value). */ identifier?: pulumi.Input<string>; /** * org_id of the environment. */ orgId?: pulumi.Input<string>; /** * project_id of the environment. */ projectId?: pulumi.Input<string>; /** * scope at which the environment exists in harness. */ scope?: pulumi.Input<string>; } /** * The set of arguments for constructing a EnvironmentClustersMapping resource. */ export interface EnvironmentClustersMappingArgs { /** * list of cluster identifiers and names */ clusters?: pulumi.Input<pulumi.Input<inputs.platform.EnvironmentClustersMappingCluster>[]>; /** * environment identifier. */ envId: pulumi.Input<string>; /** * identifier for the cluster mapping(can be given any value). */ identifier: pulumi.Input<string>; /** * org_id of the environment. */ orgId?: pulumi.Input<string>; /** * project_id of the environment. */ projectId?: pulumi.Input<string>; }