Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. Mk8sKubeconfig
Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
pulumiverse/pulumi-cpln

cpln.Mk8sKubeconfig

Explore with Pulumi AI

cpln logo
Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
pulumiverse/pulumi-cpln

    Obtain the Cluster’s Kubeconfig.

    Declaration

    Required

    • name (String) Name of the Mk8s.

    Note Only one of the below can be included in the resource.

    • profile (String) The name of the cpln profile used to generate the kubeconfig file for authenticating with your Kubernetes cluster.
    • service_account (String) The name of an existing service account for which a key will be generated, enabling kubeconfig-based authentication with your Kubernetes cluster.

    Outputs

    The following attributes are exported:

    • kubeconfig (String) The Kubeconfig in YAML format.

    Example Usage

    Profile

    import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumiverse/cpln";

export = async () => {
    const _new = new cpln.Mk8sKubeconfig("new", {profile: "default"});
    return {
        "generic-cluster-kubeconfig": _new.kubeconfig,
    };
}

    import pulumi
import pulumiverse_cpln as cpln

new = cpln.Mk8sKubeconfig("new", profile="default")
pulumi.export("generic-cluster-kubeconfig", new.kubeconfig)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		new, err := cpln.NewMk8sKubeconfig(ctx, "new", &cpln.Mk8sKubeconfigArgs{
			Profile: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		ctx.Export("generic-cluster-kubeconfig", new.Kubeconfig)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cpln = Pulumiverse.Cpln;

return await Deployment.RunAsync(() => 
{
    var @new = new Cpln.Mk8sKubeconfig("new", new()
    {
        Profile = "default",
    });

    return new Dictionary<string, object?>
    {
        ["generic-cluster-kubeconfig"] = @new.Kubeconfig,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cpln.Mk8sKubeconfig;
import com.pulumi.cpln.Mk8sKubeconfigArgs;
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 new_ = new Mk8sKubeconfig("new", Mk8sKubeconfigArgs.builder()
            .profile("default")
            .build());

        ctx.export("generic-cluster-kubeconfig", new_.kubeconfig());
    }
}

    resources:
  new:
    type: cpln:Mk8sKubeconfig
    properties:
      profile: default
outputs:
  generic-cluster-kubeconfig: ${new.kubeconfig}

    Service Account

    import * as pulumi from "@pulumi/pulumi";
import * as cpln from "@pulumiverse/cpln";

export = async () => {
    const _new = new cpln.Mk8sKubeconfig("new", {serviceAccount: "devops-sa"});
    return {
        "generic-cluster-kubeconfig": _new.kubeconfig,
    };
}

    import pulumi
import pulumiverse_cpln as cpln

new = cpln.Mk8sKubeconfig("new", service_account="devops-sa")
pulumi.export("generic-cluster-kubeconfig", new.kubeconfig)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-cpln/sdk/go/cpln"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		new, err := cpln.NewMk8sKubeconfig(ctx, "new", &cpln.Mk8sKubeconfigArgs{
			ServiceAccount: pulumi.String("devops-sa"),
		})
		if err != nil {
			return err
		}
		ctx.Export("generic-cluster-kubeconfig", new.Kubeconfig)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cpln = Pulumiverse.Cpln;

return await Deployment.RunAsync(() => 
{
    var @new = new Cpln.Mk8sKubeconfig("new", new()
    {
        ServiceAccount = "devops-sa",
    });

    return new Dictionary<string, object?>
    {
        ["generic-cluster-kubeconfig"] = @new.Kubeconfig,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cpln.Mk8sKubeconfig;
import com.pulumi.cpln.Mk8sKubeconfigArgs;
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 new_ = new Mk8sKubeconfig("new", Mk8sKubeconfigArgs.builder()
            .serviceAccount("devops-sa")
            .build());

        ctx.export("generic-cluster-kubeconfig", new_.kubeconfig());
    }
}

    resources:
  new:
    type: cpln:Mk8sKubeconfig
    properties:
      serviceAccount: devops-sa
outputs:
  generic-cluster-kubeconfig: ${new.kubeconfig}

    Create Mk8sKubeconfig Resource

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

    Constructor syntax

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

@overload
def Mk8sKubeconfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   profile: Optional[str] = None,
                   service_account: Optional[str] = None)
    func NewMk8sKubeconfig(ctx *Context, name string, args *Mk8sKubeconfigArgs, opts ...ResourceOption) (*Mk8sKubeconfig, error)
    public Mk8sKubeconfig(string name, Mk8sKubeconfigArgs? args = null, CustomResourceOptions? opts = null)
    public Mk8sKubeconfig(String name, Mk8sKubeconfigArgs args)
public Mk8sKubeconfig(String name, Mk8sKubeconfigArgs args, CustomResourceOptions options)

    type: cpln:Mk8sKubeconfig
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 Mk8sKubeconfigArgs
    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 Mk8sKubeconfigArgs
    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 Mk8sKubeconfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Mk8sKubeconfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Mk8sKubeconfigArgs
    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 mk8sKubeconfigResource = new Cpln.Mk8sKubeconfig("mk8sKubeconfigResource", new()
{
    Name = "string",
    Profile = "string",
    ServiceAccount = "string",
});

    example, err := cpln.NewMk8sKubeconfig(ctx, "mk8sKubeconfigResource", &cpln.Mk8sKubeconfigArgs{
	Name:           pulumi.String("string"),
	Profile:        pulumi.String("string"),
	ServiceAccount: pulumi.String("string"),
})

    var mk8sKubeconfigResource = new Mk8sKubeconfig("mk8sKubeconfigResource", Mk8sKubeconfigArgs.builder()
    .name("string")
    .profile("string")
    .serviceAccount("string")
    .build());

    mk8s_kubeconfig_resource = cpln.Mk8sKubeconfig("mk8sKubeconfigResource",
    name="string",
    profile="string",
    service_account="string")

    const mk8sKubeconfigResource = new cpln.Mk8sKubeconfig("mk8sKubeconfigResource", {
    name: "string",
    profile: "string",
    serviceAccount: "string",
});

    type: cpln:Mk8sKubeconfig
properties:
    name: string
    profile: string
    serviceAccount: string

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

    Name string
    Name of the MK8s to create the Kubeconfig for.
    Profile string
    Profile name to extract the token from.
    ServiceAccount string
    A service account to add a key to.
    Name string
    Name of the MK8s to create the Kubeconfig for.
    Profile string
    Profile name to extract the token from.
    ServiceAccount string
    A service account to add a key to.
    name String
    Name of the MK8s to create the Kubeconfig for.
    profile String
    Profile name to extract the token from.
    serviceAccount String
    A service account to add a key to.
    name string
    Name of the MK8s to create the Kubeconfig for.
    profile string
    Profile name to extract the token from.
    serviceAccount string
    A service account to add a key to.
    name str
    Name of the MK8s to create the Kubeconfig for.
    profile str
    Profile name to extract the token from.
    service_account str
    A service account to add a key to.
    name String
    Name of the MK8s to create the Kubeconfig for.
    profile String
    Profile name to extract the token from.
    serviceAccount String
    A service account to add a key to.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The Kubeconfig of your MK8s cluster in YAML format.
    id string
    The provider-assigned unique ID for this managed resource.
    kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    id str
    The provider-assigned unique ID for this managed resource.
    kubeconfig str
    The Kubeconfig of your MK8s cluster in YAML format.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The Kubeconfig of your MK8s cluster in YAML format.

    Look up Existing Mk8sKubeconfig Resource

    Get an existing Mk8sKubeconfig 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?: Mk8sKubeconfigState, opts?: CustomResourceOptions): Mk8sKubeconfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        kubeconfig: Optional[str] = None,
        name: Optional[str] = None,
        profile: Optional[str] = None,
        service_account: Optional[str] = None) -> Mk8sKubeconfig
    func GetMk8sKubeconfig(ctx *Context, name string, id IDInput, state *Mk8sKubeconfigState, opts ...ResourceOption) (*Mk8sKubeconfig, error)
    public static Mk8sKubeconfig Get(string name, Input<string> id, Mk8sKubeconfigState? state, CustomResourceOptions? opts = null)
    public static Mk8sKubeconfig get(String name, Output<String> id, Mk8sKubeconfigState state, CustomResourceOptions options)
    resources:  _:    type: cpln:Mk8sKubeconfig    get:      id: ${id}
    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:
    Kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    Name string
    Name of the MK8s to create the Kubeconfig for.
    Profile string
    Profile name to extract the token from.
    ServiceAccount string
    A service account to add a key to.
    Kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    Name string
    Name of the MK8s to create the Kubeconfig for.
    Profile string
    Profile name to extract the token from.
    ServiceAccount string
    A service account to add a key to.
    kubeconfig String
    The Kubeconfig of your MK8s cluster in YAML format.
    name String
    Name of the MK8s to create the Kubeconfig for.
    profile String
    Profile name to extract the token from.
    serviceAccount String
    A service account to add a key to.
    kubeconfig string
    The Kubeconfig of your MK8s cluster in YAML format.
    name string
    Name of the MK8s to create the Kubeconfig for.
    profile string
    Profile name to extract the token from.
    serviceAccount string
    A service account to add a key to.
    kubeconfig str
    The Kubeconfig of your MK8s cluster in YAML format.
    name str
    Name of the MK8s to create the Kubeconfig for.
    profile str
    Profile name to extract the token from.
    service_account str
    A service account to add a key to.
    kubeconfig String
    The Kubeconfig of your MK8s cluster in YAML format.
    name String
    Name of the MK8s to create the Kubeconfig for.
    profile String
    Profile name to extract the token from.
    serviceAccount String
    A service account to add a key to.

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
    pulumiverse/pulumi-cpln