1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. EnvironmentClustersMapping
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.EnvironmentClustersMapping

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for mapping environment with Harness Clusters.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.EnvironmentClustersMapping("example", new()
        {
            Identifier = "identifier",
            OrgId = "orgIdentifer",
            ProjectId = "projectIdentifier",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewEnvironmentClustersMapping(ctx, "example", &platform.EnvironmentClustersMappingArgs{
    			Identifier: pulumi.String("identifier"),
    			OrgId:      pulumi.String("orgIdentifer"),
    			ProjectId:  pulumi.String("projectIdentifier"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.EnvironmentClustersMapping;
    import com.pulumi.harness.platform.EnvironmentClustersMappingArgs;
    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 example = new EnvironmentClustersMapping("example", EnvironmentClustersMappingArgs.builder()        
                .identifier("identifier")
                .orgId("orgIdentifer")
                .projectId("projectIdentifier")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    example = harness.platform.EnvironmentClustersMapping("example",
        identifier="identifier",
        org_id="orgIdentifer",
        project_id="projectIdentifier")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const example = new harness.platform.EnvironmentClustersMapping("example", {
        identifier: "identifier",
        orgId: "orgIdentifer",
        projectId: "projectIdentifier",
    });
    
    resources:
      example:
        type: harness:platform:EnvironmentClustersMapping
        properties:
          identifier: identifier
          orgId: orgIdentifer
          projectId: projectIdentifier
    

    Create EnvironmentClustersMapping Resource

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

    Constructor syntax

    new EnvironmentClustersMapping(name: string, args: EnvironmentClustersMappingArgs, opts?: CustomResourceOptions);
    @overload
    def EnvironmentClustersMapping(resource_name: str,
                                   args: EnvironmentClustersMappingArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnvironmentClustersMapping(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   env_id: Optional[str] = None,
                                   identifier: Optional[str] = None,
                                   clusters: Optional[Sequence[EnvironmentClustersMappingClusterArgs]] = None,
                                   org_id: Optional[str] = None,
                                   project_id: Optional[str] = None)
    func NewEnvironmentClustersMapping(ctx *Context, name string, args EnvironmentClustersMappingArgs, opts ...ResourceOption) (*EnvironmentClustersMapping, error)
    public EnvironmentClustersMapping(string name, EnvironmentClustersMappingArgs args, CustomResourceOptions? opts = null)
    public EnvironmentClustersMapping(String name, EnvironmentClustersMappingArgs args)
    public EnvironmentClustersMapping(String name, EnvironmentClustersMappingArgs args, CustomResourceOptions options)
    
    type: harness:platform:EnvironmentClustersMapping
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var environmentClustersMappingResource = new Harness.Platform.EnvironmentClustersMapping("environmentClustersMappingResource", new()
    {
        EnvId = "string",
        Identifier = "string",
        Clusters = new[]
        {
            new Harness.Platform.Inputs.EnvironmentClustersMappingClusterArgs
            {
                Identifier = "string",
                Name = "string",
                Scope = "string",
            },
        },
        OrgId = "string",
        ProjectId = "string",
    });
    
    example, err := platform.NewEnvironmentClustersMapping(ctx, "environmentClustersMappingResource", &platform.EnvironmentClustersMappingArgs{
    	EnvId:      pulumi.String("string"),
    	Identifier: pulumi.String("string"),
    	Clusters: platform.EnvironmentClustersMappingClusterArray{
    		&platform.EnvironmentClustersMappingClusterArgs{
    			Identifier: pulumi.String("string"),
    			Name:       pulumi.String("string"),
    			Scope:      pulumi.String("string"),
    		},
    	},
    	OrgId:     pulumi.String("string"),
    	ProjectId: pulumi.String("string"),
    })
    
    var environmentClustersMappingResource = new EnvironmentClustersMapping("environmentClustersMappingResource", EnvironmentClustersMappingArgs.builder()        
        .envId("string")
        .identifier("string")
        .clusters(EnvironmentClustersMappingClusterArgs.builder()
            .identifier("string")
            .name("string")
            .scope("string")
            .build())
        .orgId("string")
        .projectId("string")
        .build());
    
    environment_clusters_mapping_resource = harness.platform.EnvironmentClustersMapping("environmentClustersMappingResource",
        env_id="string",
        identifier="string",
        clusters=[harness.platform.EnvironmentClustersMappingClusterArgs(
            identifier="string",
            name="string",
            scope="string",
        )],
        org_id="string",
        project_id="string")
    
    const environmentClustersMappingResource = new harness.platform.EnvironmentClustersMapping("environmentClustersMappingResource", {
        envId: "string",
        identifier: "string",
        clusters: [{
            identifier: "string",
            name: "string",
            scope: "string",
        }],
        orgId: "string",
        projectId: "string",
    });
    
    type: harness:platform:EnvironmentClustersMapping
    properties:
        clusters:
            - identifier: string
              name: string
              scope: string
        envId: string
        identifier: string
        orgId: string
        projectId: string
    

    EnvironmentClustersMapping Resource Properties

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

    Inputs

    The EnvironmentClustersMapping resource accepts the following input properties:

    EnvId string
    environment identifier.
    Identifier string
    identifier of the cluster.
    Clusters List<Lbrlabs.PulumiPackage.Harness.Platform.Inputs.EnvironmentClustersMappingCluster>
    list of cluster identifiers and names
    OrgId string
    org_id of the cluster.
    ProjectId string
    project_id of the cluster.
    EnvId string
    environment identifier.
    Identifier string
    identifier of the cluster.
    Clusters []EnvironmentClustersMappingClusterArgs
    list of cluster identifiers and names
    OrgId string
    org_id of the cluster.
    ProjectId string
    project_id of the cluster.
    envId String
    environment identifier.
    identifier String
    identifier of the cluster.
    clusters List<EnvironmentClustersMappingCluster>
    list of cluster identifiers and names
    orgId String
    org_id of the cluster.
    projectId String
    project_id of the cluster.
    envId string
    environment identifier.
    identifier string
    identifier of the cluster.
    clusters EnvironmentClustersMappingCluster[]
    list of cluster identifiers and names
    orgId string
    org_id of the cluster.
    projectId string
    project_id of the cluster.
    env_id str
    environment identifier.
    identifier str
    identifier of the cluster.
    clusters Sequence[EnvironmentClustersMappingClusterArgs]
    list of cluster identifiers and names
    org_id str
    org_id of the cluster.
    project_id str
    project_id of the cluster.
    envId String
    environment identifier.
    identifier String
    identifier of the cluster.
    clusters List<Property Map>
    list of cluster identifiers and names
    orgId String
    org_id of the cluster.
    projectId String
    project_id of the cluster.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Scope string
    scope at which the cluster exists in harness gitops
    Id string
    The provider-assigned unique ID for this managed resource.
    Scope string
    scope at which the cluster exists in harness gitops
    id String
    The provider-assigned unique ID for this managed resource.
    scope String
    scope at which the cluster exists in harness gitops
    id string
    The provider-assigned unique ID for this managed resource.
    scope string
    scope at which the cluster exists in harness gitops
    id str
    The provider-assigned unique ID for this managed resource.
    scope str
    scope at which the cluster exists in harness gitops
    id String
    The provider-assigned unique ID for this managed resource.
    scope String
    scope at which the cluster exists in harness gitops

    Look up Existing EnvironmentClustersMapping Resource

    Get an existing EnvironmentClustersMapping 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?: EnvironmentClustersMappingState, opts?: CustomResourceOptions): EnvironmentClustersMapping
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            clusters: Optional[Sequence[EnvironmentClustersMappingClusterArgs]] = None,
            env_id: Optional[str] = None,
            identifier: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            scope: Optional[str] = None) -> EnvironmentClustersMapping
    func GetEnvironmentClustersMapping(ctx *Context, name string, id IDInput, state *EnvironmentClustersMappingState, opts ...ResourceOption) (*EnvironmentClustersMapping, error)
    public static EnvironmentClustersMapping Get(string name, Input<string> id, EnvironmentClustersMappingState? state, CustomResourceOptions? opts = null)
    public static EnvironmentClustersMapping get(String name, Output<String> id, EnvironmentClustersMappingState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Clusters List<Lbrlabs.PulumiPackage.Harness.Platform.Inputs.EnvironmentClustersMappingCluster>
    list of cluster identifiers and names
    EnvId string
    environment identifier.
    Identifier string
    identifier of the cluster.
    OrgId string
    org_id of the cluster.
    ProjectId string
    project_id of the cluster.
    Scope string
    scope at which the cluster exists in harness gitops
    Clusters []EnvironmentClustersMappingClusterArgs
    list of cluster identifiers and names
    EnvId string
    environment identifier.
    Identifier string
    identifier of the cluster.
    OrgId string
    org_id of the cluster.
    ProjectId string
    project_id of the cluster.
    Scope string
    scope at which the cluster exists in harness gitops
    clusters List<EnvironmentClustersMappingCluster>
    list of cluster identifiers and names
    envId String
    environment identifier.
    identifier String
    identifier of the cluster.
    orgId String
    org_id of the cluster.
    projectId String
    project_id of the cluster.
    scope String
    scope at which the cluster exists in harness gitops
    clusters EnvironmentClustersMappingCluster[]
    list of cluster identifiers and names
    envId string
    environment identifier.
    identifier string
    identifier of the cluster.
    orgId string
    org_id of the cluster.
    projectId string
    project_id of the cluster.
    scope string
    scope at which the cluster exists in harness gitops
    clusters Sequence[EnvironmentClustersMappingClusterArgs]
    list of cluster identifiers and names
    env_id str
    environment identifier.
    identifier str
    identifier of the cluster.
    org_id str
    org_id of the cluster.
    project_id str
    project_id of the cluster.
    scope str
    scope at which the cluster exists in harness gitops
    clusters List<Property Map>
    list of cluster identifiers and names
    envId String
    environment identifier.
    identifier String
    identifier of the cluster.
    orgId String
    org_id of the cluster.
    projectId String
    project_id of the cluster.
    scope String
    scope at which the cluster exists in harness gitops

    Supporting Types

    EnvironmentClustersMappingCluster, EnvironmentClustersMappingClusterArgs

    Identifier string
    account Identifier of the account
    Name string
    name of the cluster
    Scope string
    scope at which the cluster exists in harness gitops, project vs org vs account
    Identifier string
    account Identifier of the account
    Name string
    name of the cluster
    Scope string
    scope at which the cluster exists in harness gitops, project vs org vs account
    identifier String
    account Identifier of the account
    name String
    name of the cluster
    scope String
    scope at which the cluster exists in harness gitops, project vs org vs account
    identifier string
    account Identifier of the account
    name string
    name of the cluster
    scope string
    scope at which the cluster exists in harness gitops, project vs org vs account
    identifier str
    account Identifier of the account
    name str
    name of the cluster
    scope str
    scope at which the cluster exists in harness gitops, project vs org vs account
    identifier String
    account Identifier of the account
    name String
    name of the cluster
    scope String
    scope at which the cluster exists in harness gitops, project vs org vs account

    Import

    Import using the cluster.

     $ pulumi import harness:platform/environmentClustersMapping:EnvironmentClustersMapping example <cluster_id>
    

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

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs