1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. ConnectorRancher
Harness v0.7.1 published on Saturday, Mar 29, 2025 by Pulumi

harness.platform.ConnectorRancher

Explore with Pulumi AI

Resource for creating a Rancher connector.

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  bearerToken:
    type: harness:platform:KubernetesConnector
    name: bearer_token
    properties:
      identifier: identifier
      name: name
      description: description
      tags:
        - foo:bar
      delegateSelectors:
        - harness-delegate
      rancherUrl: https://rancher.cluster.example
      bearerToken:
        - bearerTokenRef: account.test_rancher_bearer_token
Copy

Create ConnectorRancher Resource

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

Constructor syntax

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

@overload
def ConnectorRancher(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     identifier: Optional[str] = None,
                     rancher_url: Optional[str] = None,
                     bearer_token: Optional[ConnectorRancherBearerTokenArgs] = None,
                     delegate_selectors: Optional[Sequence[str]] = None,
                     description: Optional[str] = None,
                     force_delete: Optional[bool] = None,
                     name: Optional[str] = None,
                     org_id: Optional[str] = None,
                     project_id: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None)
func NewConnectorRancher(ctx *Context, name string, args ConnectorRancherArgs, opts ...ResourceOption) (*ConnectorRancher, error)
public ConnectorRancher(string name, ConnectorRancherArgs args, CustomResourceOptions? opts = null)
public ConnectorRancher(String name, ConnectorRancherArgs args)
public ConnectorRancher(String name, ConnectorRancherArgs args, CustomResourceOptions options)
type: harness:platform:ConnectorRancher
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. ConnectorRancherArgs
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. ConnectorRancherArgs
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. ConnectorRancherArgs
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. ConnectorRancherArgs
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. ConnectorRancherArgs
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 connectorRancherResource = new Harness.Platform.ConnectorRancher("connectorRancherResource", new()
{
    Identifier = "string",
    RancherUrl = "string",
    BearerToken = new Harness.Platform.Inputs.ConnectorRancherBearerTokenArgs
    {
        BearerTokenRef = "string",
    },
    DelegateSelectors = new[]
    {
        "string",
    },
    Description = "string",
    ForceDelete = false,
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := platform.NewConnectorRancher(ctx, "connectorRancherResource", &platform.ConnectorRancherArgs{
	Identifier: pulumi.String("string"),
	RancherUrl: pulumi.String("string"),
	BearerToken: &platform.ConnectorRancherBearerTokenArgs{
		BearerTokenRef: pulumi.String("string"),
	},
	DelegateSelectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	ForceDelete: pulumi.Bool(false),
	Name:        pulumi.String("string"),
	OrgId:       pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var connectorRancherResource = new ConnectorRancher("connectorRancherResource", ConnectorRancherArgs.builder()
    .identifier("string")
    .rancherUrl("string")
    .bearerToken(ConnectorRancherBearerTokenArgs.builder()
        .bearerTokenRef("string")
        .build())
    .delegateSelectors("string")
    .description("string")
    .forceDelete(false)
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());
Copy
connector_rancher_resource = harness.platform.ConnectorRancher("connectorRancherResource",
    identifier="string",
    rancher_url="string",
    bearer_token={
        "bearer_token_ref": "string",
    },
    delegate_selectors=["string"],
    description="string",
    force_delete=False,
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])
Copy
const connectorRancherResource = new harness.platform.ConnectorRancher("connectorRancherResource", {
    identifier: "string",
    rancherUrl: "string",
    bearerToken: {
        bearerTokenRef: "string",
    },
    delegateSelectors: ["string"],
    description: "string",
    forceDelete: false,
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});
Copy
type: harness:platform:ConnectorRancher
properties:
    bearerToken:
        bearerTokenRef: string
    delegateSelectors:
        - string
    description: string
    forceDelete: false
    identifier: string
    name: string
    orgId: string
    projectId: string
    rancherUrl: string
    tags:
        - string
Copy

ConnectorRancher 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 ConnectorRancher resource accepts the following input properties:

Identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
RancherUrl This property is required. string
The URL of the Rancher cluster.
BearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
DelegateSelectors List<string>
Selectors to use for the delegate.
Description string
Description of the resource.
ForceDelete bool
Enable this flag for force deletion of connector
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
Tags List<string>
Tags to associate with the resource.
Identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
RancherUrl This property is required. string
The URL of the Rancher cluster.
BearerToken ConnectorRancherBearerTokenArgs
Bearer token information for the rancher cluster.
DelegateSelectors []string
Selectors to use for the delegate.
Description string
Description of the resource.
ForceDelete bool
Enable this flag for force deletion of connector
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
Tags []string
Tags to associate with the resource.
identifier
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the resource.
rancherUrl This property is required. String
The URL of the Rancher cluster.
bearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
delegateSelectors List<String>
Selectors to use for the delegate.
description String
Description of the resource.
forceDelete Boolean
Enable this flag for force deletion of connector
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
tags List<String>
Tags to associate with the resource.
identifier
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the resource.
rancherUrl This property is required. string
The URL of the Rancher cluster.
bearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
delegateSelectors string[]
Selectors to use for the delegate.
description string
Description of the resource.
forceDelete boolean
Enable this flag for force deletion of connector
name string
Name of the resource.
orgId string
Unique identifier of the organization.
projectId string
Unique identifier of the project.
tags string[]
Tags to associate with the resource.
identifier
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier of the resource.
rancher_url This property is required. str
The URL of the Rancher cluster.
bearer_token ConnectorRancherBearerTokenArgs
Bearer token information for the rancher cluster.
delegate_selectors Sequence[str]
Selectors to use for the delegate.
description str
Description of the resource.
force_delete bool
Enable this flag for force deletion of connector
name str
Name of the resource.
org_id str
Unique identifier of the organization.
project_id str
Unique identifier of the project.
tags Sequence[str]
Tags to associate with the resource.
identifier
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the resource.
rancherUrl This property is required. String
The URL of the Rancher cluster.
bearerToken Property Map
Bearer token information for the rancher cluster.
delegateSelectors List<String>
Selectors to use for the delegate.
description String
Description of the resource.
forceDelete Boolean
Enable this flag for force deletion of connector
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
tags List<String>
Tags to associate with the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectorRancher 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 ConnectorRancher Resource

Get an existing ConnectorRancher 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?: ConnectorRancherState, opts?: CustomResourceOptions): ConnectorRancher
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bearer_token: Optional[ConnectorRancherBearerTokenArgs] = None,
        delegate_selectors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        force_delete: Optional[bool] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        rancher_url: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> ConnectorRancher
func GetConnectorRancher(ctx *Context, name string, id IDInput, state *ConnectorRancherState, opts ...ResourceOption) (*ConnectorRancher, error)
public static ConnectorRancher Get(string name, Input<string> id, ConnectorRancherState? state, CustomResourceOptions? opts = null)
public static ConnectorRancher get(String name, Output<String> id, ConnectorRancherState state, CustomResourceOptions options)
resources:  _:    type: harness:platform:ConnectorRancher    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:
BearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
DelegateSelectors List<string>
Selectors to use for the delegate.
Description string
Description of the resource.
ForceDelete bool
Enable this flag for force deletion of connector
Identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
RancherUrl string
The URL of the Rancher cluster.
Tags List<string>
Tags to associate with the resource.
BearerToken ConnectorRancherBearerTokenArgs
Bearer token information for the rancher cluster.
DelegateSelectors []string
Selectors to use for the delegate.
Description string
Description of the resource.
ForceDelete bool
Enable this flag for force deletion of connector
Identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
Name string
Name of the resource.
OrgId string
Unique identifier of the organization.
ProjectId string
Unique identifier of the project.
RancherUrl string
The URL of the Rancher cluster.
Tags []string
Tags to associate with the resource.
bearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
delegateSelectors List<String>
Selectors to use for the delegate.
description String
Description of the resource.
forceDelete Boolean
Enable this flag for force deletion of connector
identifier Changes to this property will trigger replacement. String
Unique identifier of the resource.
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
rancherUrl String
The URL of the Rancher cluster.
tags List<String>
Tags to associate with the resource.
bearerToken ConnectorRancherBearerToken
Bearer token information for the rancher cluster.
delegateSelectors string[]
Selectors to use for the delegate.
description string
Description of the resource.
forceDelete boolean
Enable this flag for force deletion of connector
identifier Changes to this property will trigger replacement. string
Unique identifier of the resource.
name string
Name of the resource.
orgId string
Unique identifier of the organization.
projectId string
Unique identifier of the project.
rancherUrl string
The URL of the Rancher cluster.
tags string[]
Tags to associate with the resource.
bearer_token ConnectorRancherBearerTokenArgs
Bearer token information for the rancher cluster.
delegate_selectors Sequence[str]
Selectors to use for the delegate.
description str
Description of the resource.
force_delete bool
Enable this flag for force deletion of connector
identifier Changes to this property will trigger replacement. str
Unique identifier of the resource.
name str
Name of the resource.
org_id str
Unique identifier of the organization.
project_id str
Unique identifier of the project.
rancher_url str
The URL of the Rancher cluster.
tags Sequence[str]
Tags to associate with the resource.
bearerToken Property Map
Bearer token information for the rancher cluster.
delegateSelectors List<String>
Selectors to use for the delegate.
description String
Description of the resource.
forceDelete Boolean
Enable this flag for force deletion of connector
identifier Changes to this property will trigger replacement. String
Unique identifier of the resource.
name String
Name of the resource.
orgId String
Unique identifier of the organization.
projectId String
Unique identifier of the project.
rancherUrl String
The URL of the Rancher cluster.
tags List<String>
Tags to associate with the resource.

Supporting Types

ConnectorRancherBearerToken
, ConnectorRancherBearerTokenArgs

BearerTokenRef This property is required. string
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
BearerTokenRef This property is required. string
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
bearerTokenRef This property is required. String
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
bearerTokenRef This property is required. string
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
bearer_token_ref This property is required. str
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
bearerTokenRef This property is required. String
Reference to the secret containing the bearer token for the rancher cluster. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

Import

Import account level rancher connector

$ pulumi import harness:platform/connectorRancher:ConnectorRancher example <connector_id>
Copy

Import org level rancher connector

$ pulumi import harness:platform/connectorRancher:ConnectorRancher example <ord_id>/<connector_id>
Copy

Import project level rancher connector

$ pulumi import harness:platform/connectorRancher:ConnectorRancher example <org_id>/<project_id>/<connector_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.