Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. cluster
  5. Orchestrator
Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

harness.cluster.Orchestrator

Explore with Pulumi AI

Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness

Resource for creating ClusterOrchestrators.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";

const test = new harness.cluster.Orchestrator("test", {
    name: "name",
    clusterEndpoint: "http://test.test.com",
    k8sConnectorId: "test",
});
Copy
import pulumi
import pulumi_harness as harness

test = harness.cluster.Orchestrator("test",
    name="name",
    cluster_endpoint="http://test.test.com",
    k8s_connector_id="test")
Copy
package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/cluster"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cluster.NewOrchestrator(ctx, "test", &cluster.OrchestratorArgs{
			Name:            pulumi.String("name"),
			ClusterEndpoint: pulumi.String("http://test.test.com"),
			K8sConnectorId:  pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var test = new Harness.Cluster.Orchestrator("test", new()
    {
        Name = "name",
        ClusterEndpoint = "http://test.test.com",
        K8sConnectorId = "test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.cluster.Orchestrator;
import com.pulumi.harness.cluster.OrchestratorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new Orchestrator("test", OrchestratorArgs.builder()
            .name("name")
            .clusterEndpoint("http://test.test.com")
            .k8sConnectorId("test")
            .build());

    }
}
Copy
resources:
  test:
    type: harness:cluster:Orchestrator
    properties:
      name: name
      clusterEndpoint: http://test.test.com
      k8sConnectorId: test
Copy

Create Orchestrator Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Orchestrator(name: string, args: OrchestratorArgs, opts?: CustomResourceOptions);
@overload
def Orchestrator(resource_name: str,
                 args: OrchestratorArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Orchestrator(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_endpoint: Optional[str] = None,
                 k8s_connector_id: Optional[str] = None,
                 name: Optional[str] = None)
func NewOrchestrator(ctx *Context, name string, args OrchestratorArgs, opts ...ResourceOption) (*Orchestrator, error)
public Orchestrator(string name, OrchestratorArgs args, CustomResourceOptions? opts = null)
public Orchestrator(String name, OrchestratorArgs args)
public Orchestrator(String name, OrchestratorArgs args, CustomResourceOptions options)

type: harness:cluster:Orchestrator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OrchestratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OrchestratorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OrchestratorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OrchestratorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OrchestratorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var orchestratorResource = new Harness.Cluster.Orchestrator("orchestratorResource", new()
{
    ClusterEndpoint = "string",
    K8sConnectorId = "string",
    Name = "string",
});
Copy
example, err := cluster.NewOrchestrator(ctx, "orchestratorResource", &cluster.OrchestratorArgs{
	ClusterEndpoint: pulumi.String("string"),
	K8sConnectorId:  pulumi.String("string"),
	Name:            pulumi.String("string"),
})
Copy
var orchestratorResource = new Orchestrator("orchestratorResource", OrchestratorArgs.builder()
    .clusterEndpoint("string")
    .k8sConnectorId("string")
    .name("string")
    .build());
Copy
orchestrator_resource = harness.cluster.Orchestrator("orchestratorResource",
    cluster_endpoint="string",
    k8s_connector_id="string",
    name="string")
Copy
const orchestratorResource = new harness.cluster.Orchestrator("orchestratorResource", {
    clusterEndpoint: "string",
    k8sConnectorId: "string",
    name: "string",
});
Copy
type: harness:cluster:Orchestrator
properties:
    clusterEndpoint: string
    k8sConnectorId: string
    name: string
Copy

Orchestrator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Orchestrator resource accepts the following input properties:

ClusterEndpoint This property is required. string
Endpoint of the k8s cluster being onboarded under the orchestrator
K8sConnectorId This property is required. string
ID of the Harness Kubernetes Connector Being used
Name string
Name of the Orchestrator
ClusterEndpoint This property is required. string
Endpoint of the k8s cluster being onboarded under the orchestrator
K8sConnectorId This property is required. string
ID of the Harness Kubernetes Connector Being used
Name string
Name of the Orchestrator
clusterEndpoint This property is required. String
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId This property is required. String
ID of the Harness Kubernetes Connector Being used
name String
Name of the Orchestrator
clusterEndpoint This property is required. string
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId This property is required. string
ID of the Harness Kubernetes Connector Being used
name string
Name of the Orchestrator
cluster_endpoint This property is required. str
Endpoint of the k8s cluster being onboarded under the orchestrator
k8s_connector_id This property is required. str
ID of the Harness Kubernetes Connector Being used
name str
Name of the Orchestrator
clusterEndpoint This property is required. String
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId This property is required. String
ID of the Harness Kubernetes Connector Being used
name String
Name of the Orchestrator

Outputs

All input properties are implicitly available as output properties. Additionally, the Orchestrator resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Orchestrator Resource

Get an existing Orchestrator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrchestratorState, opts?: CustomResourceOptions): Orchestrator
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_endpoint: Optional[str] = None,
        k8s_connector_id: Optional[str] = None,
        name: Optional[str] = None) -> Orchestrator
func GetOrchestrator(ctx *Context, name string, id IDInput, state *OrchestratorState, opts ...ResourceOption) (*Orchestrator, error)
public static Orchestrator Get(string name, Input<string> id, OrchestratorState? state, CustomResourceOptions? opts = null)
public static Orchestrator get(String name, Output<String> id, OrchestratorState state, CustomResourceOptions options)
resources:  _:    type: harness:cluster:Orchestrator    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterEndpoint string
Endpoint of the k8s cluster being onboarded under the orchestrator
K8sConnectorId string
ID of the Harness Kubernetes Connector Being used
Name string
Name of the Orchestrator
ClusterEndpoint string
Endpoint of the k8s cluster being onboarded under the orchestrator
K8sConnectorId string
ID of the Harness Kubernetes Connector Being used
Name string
Name of the Orchestrator
clusterEndpoint String
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId String
ID of the Harness Kubernetes Connector Being used
name String
Name of the Orchestrator
clusterEndpoint string
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId string
ID of the Harness Kubernetes Connector Being used
name string
Name of the Orchestrator
cluster_endpoint str
Endpoint of the k8s cluster being onboarded under the orchestrator
k8s_connector_id str
ID of the Harness Kubernetes Connector Being used
name str
Name of the Orchestrator
clusterEndpoint String
Endpoint of the k8s cluster being onboarded under the orchestrator
k8sConnectorId String
ID of the Harness Kubernetes Connector Being used
name String
Name of the Orchestrator

Import

Import using the Harness aws cloud provider id.

$ pulumi import harness:cluster/orchestrator:Orchestrator example <provider_id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
harness pulumi/pulumi-harness
License
Apache-2.0
Notes
This Pulumi package is based on the harness Terraform Provider.
Harness v0.7.2 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-harness