1. Packages
  2. Linode Provider
  3. API Docs
  4. LkeCluster
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

linode.LkeCluster

Explore with Pulumi AI

linode logo
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

    Import

    LKE Clusters can be imported using the id, e.g.

    $ pulumi import linode:index/lkeCluster:LkeCluster my_cluster 12345
    

    Create LkeCluster Resource

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

    Constructor syntax

    new LkeCluster(name: string, args: LkeClusterArgs, opts?: CustomResourceOptions);
    @overload
    def LkeCluster(resource_name: str,
                   args: LkeClusterArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def LkeCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   k8s_version: Optional[str] = None,
                   label: Optional[str] = None,
                   pools: Optional[Sequence[LkeClusterPoolArgs]] = None,
                   region: Optional[str] = None,
                   control_plane: Optional[LkeClusterControlPlaneArgs] = None,
                   external_pool_tags: Optional[Sequence[str]] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewLkeCluster(ctx *Context, name string, args LkeClusterArgs, opts ...ResourceOption) (*LkeCluster, error)
    public LkeCluster(string name, LkeClusterArgs args, CustomResourceOptions? opts = null)
    public LkeCluster(String name, LkeClusterArgs args)
    public LkeCluster(String name, LkeClusterArgs args, CustomResourceOptions options)
    
    type: linode:LkeCluster
    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 LkeClusterArgs
    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 LkeClusterArgs
    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 LkeClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LkeClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LkeClusterArgs
    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 lkeClusterResource = new Linode.LkeCluster("lkeClusterResource", new()
    {
        K8sVersion = "string",
        Label = "string",
        Pools = new[]
        {
            new Linode.Inputs.LkeClusterPoolArgs
            {
                Type = "string",
                Autoscaler = new Linode.Inputs.LkeClusterPoolAutoscalerArgs
                {
                    Max = 0,
                    Min = 0,
                },
                Count = 0,
                DiskEncryption = "string",
                Id = 0,
                Labels = 
                {
                    { "string", "string" },
                },
                Nodes = new[]
                {
                    new Linode.Inputs.LkeClusterPoolNodeArgs
                    {
                        Id = "string",
                        InstanceId = 0,
                        Status = "string",
                    },
                },
                Tags = new[]
                {
                    "string",
                },
                Taints = new[]
                {
                    new Linode.Inputs.LkeClusterPoolTaintArgs
                    {
                        Effect = "string",
                        Key = "string",
                        Value = "string",
                    },
                },
            },
        },
        Region = "string",
        ControlPlane = new Linode.Inputs.LkeClusterControlPlaneArgs
        {
            Acl = new Linode.Inputs.LkeClusterControlPlaneAclArgs
            {
                Addresses = new[]
                {
                    new Linode.Inputs.LkeClusterControlPlaneAclAddressArgs
                    {
                        Ipv4s = new[]
                        {
                            "string",
                        },
                        Ipv6s = new[]
                        {
                            "string",
                        },
                    },
                },
                Enabled = false,
            },
            HighAvailability = false,
        },
        ExternalPoolTags = new[]
        {
            "string",
        },
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := linode.NewLkeCluster(ctx, "lkeClusterResource", &linode.LkeClusterArgs{
    	K8sVersion: pulumi.String("string"),
    	Label:      pulumi.String("string"),
    	Pools: linode.LkeClusterPoolArray{
    		&linode.LkeClusterPoolArgs{
    			Type: pulumi.String("string"),
    			Autoscaler: &linode.LkeClusterPoolAutoscalerArgs{
    				Max: pulumi.Int(0),
    				Min: pulumi.Int(0),
    			},
    			Count:          pulumi.Int(0),
    			DiskEncryption: pulumi.String("string"),
    			Id:             pulumi.Int(0),
    			Labels: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			Nodes: linode.LkeClusterPoolNodeArray{
    				&linode.LkeClusterPoolNodeArgs{
    					Id:         pulumi.String("string"),
    					InstanceId: pulumi.Int(0),
    					Status:     pulumi.String("string"),
    				},
    			},
    			Tags: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Taints: linode.LkeClusterPoolTaintArray{
    				&linode.LkeClusterPoolTaintArgs{
    					Effect: pulumi.String("string"),
    					Key:    pulumi.String("string"),
    					Value:  pulumi.String("string"),
    				},
    			},
    		},
    	},
    	Region: pulumi.String("string"),
    	ControlPlane: &linode.LkeClusterControlPlaneArgs{
    		Acl: &linode.LkeClusterControlPlaneAclArgs{
    			Addresses: linode.LkeClusterControlPlaneAclAddressArray{
    				&linode.LkeClusterControlPlaneAclAddressArgs{
    					Ipv4s: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    					Ipv6s: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    				},
    			},
    			Enabled: pulumi.Bool(false),
    		},
    		HighAvailability: pulumi.Bool(false),
    	},
    	ExternalPoolTags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var lkeClusterResource = new LkeCluster("lkeClusterResource", LkeClusterArgs.builder()
        .k8sVersion("string")
        .label("string")
        .pools(LkeClusterPoolArgs.builder()
            .type("string")
            .autoscaler(LkeClusterPoolAutoscalerArgs.builder()
                .max(0)
                .min(0)
                .build())
            .count(0)
            .diskEncryption("string")
            .id(0)
            .labels(Map.of("string", "string"))
            .nodes(LkeClusterPoolNodeArgs.builder()
                .id("string")
                .instanceId(0)
                .status("string")
                .build())
            .tags("string")
            .taints(LkeClusterPoolTaintArgs.builder()
                .effect("string")
                .key("string")
                .value("string")
                .build())
            .build())
        .region("string")
        .controlPlane(LkeClusterControlPlaneArgs.builder()
            .acl(LkeClusterControlPlaneAclArgs.builder()
                .addresses(LkeClusterControlPlaneAclAddressArgs.builder()
                    .ipv4s("string")
                    .ipv6s("string")
                    .build())
                .enabled(false)
                .build())
            .highAvailability(false)
            .build())
        .externalPoolTags("string")
        .tags("string")
        .build());
    
    lke_cluster_resource = linode.LkeCluster("lkeClusterResource",
        k8s_version="string",
        label="string",
        pools=[{
            "type": "string",
            "autoscaler": {
                "max": 0,
                "min": 0,
            },
            "count": 0,
            "disk_encryption": "string",
            "id": 0,
            "labels": {
                "string": "string",
            },
            "nodes": [{
                "id": "string",
                "instance_id": 0,
                "status": "string",
            }],
            "tags": ["string"],
            "taints": [{
                "effect": "string",
                "key": "string",
                "value": "string",
            }],
        }],
        region="string",
        control_plane={
            "acl": {
                "addresses": [{
                    "ipv4s": ["string"],
                    "ipv6s": ["string"],
                }],
                "enabled": False,
            },
            "high_availability": False,
        },
        external_pool_tags=["string"],
        tags=["string"])
    
    const lkeClusterResource = new linode.LkeCluster("lkeClusterResource", {
        k8sVersion: "string",
        label: "string",
        pools: [{
            type: "string",
            autoscaler: {
                max: 0,
                min: 0,
            },
            count: 0,
            diskEncryption: "string",
            id: 0,
            labels: {
                string: "string",
            },
            nodes: [{
                id: "string",
                instanceId: 0,
                status: "string",
            }],
            tags: ["string"],
            taints: [{
                effect: "string",
                key: "string",
                value: "string",
            }],
        }],
        region: "string",
        controlPlane: {
            acl: {
                addresses: [{
                    ipv4s: ["string"],
                    ipv6s: ["string"],
                }],
                enabled: false,
            },
            highAvailability: false,
        },
        externalPoolTags: ["string"],
        tags: ["string"],
    });
    
    type: linode:LkeCluster
    properties:
        controlPlane:
            acl:
                addresses:
                    - ipv4s:
                        - string
                      ipv6s:
                        - string
                enabled: false
            highAvailability: false
        externalPoolTags:
            - string
        k8sVersion: string
        label: string
        pools:
            - autoscaler:
                max: 0
                min: 0
              count: 0
              diskEncryption: string
              id: 0
              labels:
                string: string
              nodes:
                - id: string
                  instanceId: 0
                  status: string
              tags:
                - string
              taints:
                - effect: string
                  key: string
                  value: string
              type: string
        region: string
        tags:
            - string
    

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

    K8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    Label string
    This Kubernetes cluster's unique label.
    Pools List<LkeClusterPool>
    Additional nested attributes:
    Region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    ControlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    ExternalPoolTags List<string>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    Tags List<string>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    K8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    Label string
    This Kubernetes cluster's unique label.
    Pools []LkeClusterPoolArgs
    Additional nested attributes:
    Region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    ControlPlane LkeClusterControlPlaneArgs
    Defines settings for the Kubernetes Control Plane.
    ExternalPoolTags []string
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    Tags []string
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    k8sVersion String
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    label String
    This Kubernetes cluster's unique label.
    pools List<LkeClusterPool>
    Additional nested attributes:
    region String

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    controlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    externalPoolTags List<String>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    k8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    label string
    This Kubernetes cluster's unique label.
    pools LkeClusterPool[]
    Additional nested attributes:
    region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    controlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    externalPoolTags string[]
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    tags string[]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    k8s_version str
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    label str
    This Kubernetes cluster's unique label.
    pools Sequence[LkeClusterPoolArgs]
    Additional nested attributes:
    region str

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    control_plane LkeClusterControlPlaneArgs
    Defines settings for the Kubernetes Control Plane.
    external_pool_tags Sequence[str]
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    tags Sequence[str]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    k8sVersion String
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    label String
    This Kubernetes cluster's unique label.
    pools List<Property Map>
    Additional nested attributes:
    region String

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    controlPlane Property Map
    Defines settings for the Kubernetes Control Plane.
    externalPoolTags List<String>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.

    Outputs

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

    ApiEndpoints List<string>
    The endpoints for the Kubernetes API server.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    Status string
    The status of the node. (ready, not_ready)
    ApiEndpoints []string
    The endpoints for the Kubernetes API server.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    Status string
    The status of the node. (ready, not_ready)
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The base64 encoded kubeconfig for the Kubernetes cluster.
    status String
    The status of the node. (ready, not_ready)
    apiEndpoints string[]
    The endpoints for the Kubernetes API server.
    dashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    status string
    The status of the node. (ready, not_ready)
    api_endpoints Sequence[str]
    The endpoints for the Kubernetes API server.
    dashboard_url str
    The Kubernetes Dashboard access URL for this cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    kubeconfig str
    The base64 encoded kubeconfig for the Kubernetes cluster.
    status str
    The status of the node. (ready, not_ready)
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeconfig String
    The base64 encoded kubeconfig for the Kubernetes cluster.
    status String
    The status of the node. (ready, not_ready)

    Look up Existing LkeCluster Resource

    Get an existing LkeCluster 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?: LkeClusterState, opts?: CustomResourceOptions): LkeCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_endpoints: Optional[Sequence[str]] = None,
            control_plane: Optional[LkeClusterControlPlaneArgs] = None,
            dashboard_url: Optional[str] = None,
            external_pool_tags: Optional[Sequence[str]] = None,
            k8s_version: Optional[str] = None,
            kubeconfig: Optional[str] = None,
            label: Optional[str] = None,
            pools: Optional[Sequence[LkeClusterPoolArgs]] = None,
            region: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> LkeCluster
    func GetLkeCluster(ctx *Context, name string, id IDInput, state *LkeClusterState, opts ...ResourceOption) (*LkeCluster, error)
    public static LkeCluster Get(string name, Input<string> id, LkeClusterState? state, CustomResourceOptions? opts = null)
    public static LkeCluster get(String name, Output<String> id, LkeClusterState 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:
    ApiEndpoints List<string>
    The endpoints for the Kubernetes API server.
    ControlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    ExternalPoolTags List<string>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    K8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    Kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    Label string
    This Kubernetes cluster's unique label.
    Pools List<LkeClusterPool>
    Additional nested attributes:
    Region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    Status string
    The status of the node. (ready, not_ready)
    Tags List<string>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    ApiEndpoints []string
    The endpoints for the Kubernetes API server.
    ControlPlane LkeClusterControlPlaneArgs
    Defines settings for the Kubernetes Control Plane.
    DashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    ExternalPoolTags []string
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    K8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    Kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    Label string
    This Kubernetes cluster's unique label.
    Pools []LkeClusterPoolArgs
    Additional nested attributes:
    Region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    Status string
    The status of the node. (ready, not_ready)
    Tags []string
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    controlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    externalPoolTags List<String>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    k8sVersion String
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    kubeconfig String
    The base64 encoded kubeconfig for the Kubernetes cluster.
    label String
    This Kubernetes cluster's unique label.
    pools List<LkeClusterPool>
    Additional nested attributes:
    region String

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    status String
    The status of the node. (ready, not_ready)
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    apiEndpoints string[]
    The endpoints for the Kubernetes API server.
    controlPlane LkeClusterControlPlane
    Defines settings for the Kubernetes Control Plane.
    dashboardUrl string
    The Kubernetes Dashboard access URL for this cluster.
    externalPoolTags string[]
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    k8sVersion string
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    kubeconfig string
    The base64 encoded kubeconfig for the Kubernetes cluster.
    label string
    This Kubernetes cluster's unique label.
    pools LkeClusterPool[]
    Additional nested attributes:
    region string

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    status string
    The status of the node. (ready, not_ready)
    tags string[]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    api_endpoints Sequence[str]
    The endpoints for the Kubernetes API server.
    control_plane LkeClusterControlPlaneArgs
    Defines settings for the Kubernetes Control Plane.
    dashboard_url str
    The Kubernetes Dashboard access URL for this cluster.
    external_pool_tags Sequence[str]
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    k8s_version str
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    kubeconfig str
    The base64 encoded kubeconfig for the Kubernetes cluster.
    label str
    This Kubernetes cluster's unique label.
    pools Sequence[LkeClusterPoolArgs]
    Additional nested attributes:
    region str

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    status str
    The status of the node. (ready, not_ready)
    tags Sequence[str]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    apiEndpoints List<String>
    The endpoints for the Kubernetes API server.
    controlPlane Property Map
    Defines settings for the Kubernetes Control Plane.
    dashboardUrl String
    The Kubernetes Dashboard access URL for this cluster.
    externalPoolTags List<String>
    A set of node pool tags to ignore when planning and applying this cluster. This prevents externally managed node pools from being deleted or unintentionally updated on subsequent applies. See Externally Managed Node Pools for more details.
    k8sVersion String
    The desired Kubernetes version for this Kubernetes cluster in the format of major.minor (e.g. 1.21), and the latest supported patch version will be deployed.
    kubeconfig String
    The base64 encoded kubeconfig for the Kubernetes cluster.
    label String
    This Kubernetes cluster's unique label.
    pools List<Property Map>
    Additional nested attributes:
    region String

    This Kubernetes cluster's location.

    • pool - (Required) The Node Pool specifications for the Kubernetes cluster. At least one Node Pool is required.

    • control_plane (Optional) Defines settings for the Kubernetes Control Plane.

    status String
    The status of the node. (ready, not_ready)
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.

    Supporting Types

    LkeClusterControlPlane, LkeClusterControlPlaneArgs

    Acl LkeClusterControlPlaneAcl
    Defines the ACL configuration for an LKE cluster's control plane.
    HighAvailability bool
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    Acl LkeClusterControlPlaneAcl
    Defines the ACL configuration for an LKE cluster's control plane.
    HighAvailability bool
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    acl LkeClusterControlPlaneAcl
    Defines the ACL configuration for an LKE cluster's control plane.
    highAvailability Boolean
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    acl LkeClusterControlPlaneAcl
    Defines the ACL configuration for an LKE cluster's control plane.
    highAvailability boolean
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    acl LkeClusterControlPlaneAcl
    Defines the ACL configuration for an LKE cluster's control plane.
    high_availability bool
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.
    acl Property Map
    Defines the ACL configuration for an LKE cluster's control plane.
    highAvailability Boolean
    Defines whether High Availability is enabled for the cluster Control Plane. This is an irreversible change.

    • acl - (Optional) Defines the ACL configuration for an LKE cluster's control plane. NOTE: Control Plane ACLs may not currently be available to all users.

    LkeClusterControlPlaneAcl, LkeClusterControlPlaneAclArgs

    Addresses List<LkeClusterControlPlaneAclAddress>
    A list of ip addresses to allow.
    Enabled bool
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.
    Addresses []LkeClusterControlPlaneAclAddress
    A list of ip addresses to allow.
    Enabled bool
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.
    addresses List<LkeClusterControlPlaneAclAddress>
    A list of ip addresses to allow.
    enabled Boolean
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.
    addresses LkeClusterControlPlaneAclAddress[]
    A list of ip addresses to allow.
    enabled boolean
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.
    addresses Sequence[LkeClusterControlPlaneAclAddress]
    A list of ip addresses to allow.
    enabled bool
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.
    addresses List<Property Map>
    A list of ip addresses to allow.
    enabled Boolean
    Defines default policy. A value of true results in a default policy of DENY. A value of false results in default policy of ALLOW, and has the same effect as delete the ACL configuration.

    • addresses - (Optional) A list of ip addresses to allow.

    LkeClusterControlPlaneAclAddress, LkeClusterControlPlaneAclAddressArgs

    Ipv4s List<string>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    Ipv6s List<string>
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    Ipv4s []string
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    Ipv6s []string
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s List<String>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s List<String>
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s string[]
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s string[]
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s Sequence[str]
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s Sequence[str]
    A set of individual ipv6 addresses or CIDRs to ALLOW.
    ipv4s List<String>
    A set of individual ipv4 addresses or CIDRs to ALLOW.
    ipv6s List<String>
    A set of individual ipv6 addresses or CIDRs to ALLOW.

    LkeClusterPool, LkeClusterPoolArgs

    Type string
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    Autoscaler LkeClusterPoolAutoscaler
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    Count int
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    DiskEncryption string
    The disk encryption policy for nodes in this pool.
    Id int
    The ID of the node.
    Labels Dictionary<string, string>
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    Nodes List<LkeClusterPoolNode>
    The nodes in the node pool.
    Tags List<string>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    Taints List<LkeClusterPoolTaint>
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
    Type string
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    Autoscaler LkeClusterPoolAutoscaler
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    Count int
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    DiskEncryption string
    The disk encryption policy for nodes in this pool.
    Id int
    The ID of the node.
    Labels map[string]string
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    Nodes []LkeClusterPoolNode
    The nodes in the node pool.
    Tags []string
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    Taints []LkeClusterPoolTaint
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
    type String
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    autoscaler LkeClusterPoolAutoscaler
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    count Integer
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    diskEncryption String
    The disk encryption policy for nodes in this pool.
    id Integer
    The ID of the node.
    labels Map<String,String>
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    nodes List<LkeClusterPoolNode>
    The nodes in the node pool.
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    taints List<LkeClusterPoolTaint>
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
    type string
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    autoscaler LkeClusterPoolAutoscaler
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    count number
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    diskEncryption string
    The disk encryption policy for nodes in this pool.
    id number
    The ID of the node.
    labels {[key: string]: string}
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    nodes LkeClusterPoolNode[]
    The nodes in the node pool.
    tags string[]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    taints LkeClusterPoolTaint[]
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
    type str
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    autoscaler LkeClusterPoolAutoscaler
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    count int
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    disk_encryption str
    The disk encryption policy for nodes in this pool.
    id int
    The ID of the node.
    labels Mapping[str, str]
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    nodes Sequence[LkeClusterPoolNode]
    The nodes in the node pool.
    tags Sequence[str]
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    taints Sequence[LkeClusterPoolTaint]
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.
    type String
    A Linode Type for all of the nodes in the Node Pool. See all node types here.
    autoscaler Property Map
    When specified, the number of nodes autoscales within the defined minimum and maximum values.
    count Number
    The number of nodes in the Node Pool. If undefined with an autoscaler the initial node count will equal the autoscaler minimum.

    • autoscaler - (Optional) If defined, an autoscaler will be enabled with the given configuration.
    diskEncryption String
    The disk encryption policy for nodes in this pool.
    id Number
    The ID of the node.
    labels Map<String>
    Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.
    nodes List<Property Map>
    The nodes in the node pool.
    tags List<String>
    An array of tags applied to the Kubernetes cluster. Tags are case-insensitive and are for organizational purposes only.
    taints List<Property Map>
    Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.

    LkeClusterPoolAutoscaler, LkeClusterPoolAutoscalerArgs

    Max int
    The maximum number of nodes to autoscale to.
    Min int
    The minimum number of nodes to autoscale to.
    Max int
    The maximum number of nodes to autoscale to.
    Min int
    The minimum number of nodes to autoscale to.
    max Integer
    The maximum number of nodes to autoscale to.
    min Integer
    The minimum number of nodes to autoscale to.
    max number
    The maximum number of nodes to autoscale to.
    min number
    The minimum number of nodes to autoscale to.
    max int
    The maximum number of nodes to autoscale to.
    min int
    The minimum number of nodes to autoscale to.
    max Number
    The maximum number of nodes to autoscale to.
    min Number
    The minimum number of nodes to autoscale to.

    LkeClusterPoolNode, LkeClusterPoolNodeArgs

    Id string
    The ID of the node.
    InstanceId int
    The ID of the underlying Linode instance.
    Status string
    The status of the node. (ready, not_ready)
    Id string
    The ID of the node.
    InstanceId int
    The ID of the underlying Linode instance.
    Status string
    The status of the node. (ready, not_ready)
    id String
    The ID of the node.
    instanceId Integer
    The ID of the underlying Linode instance.
    status String
    The status of the node. (ready, not_ready)
    id string
    The ID of the node.
    instanceId number
    The ID of the underlying Linode instance.
    status string
    The status of the node. (ready, not_ready)
    id str
    The ID of the node.
    instance_id int
    The ID of the underlying Linode instance.
    status str
    The status of the node. (ready, not_ready)
    id String
    The ID of the node.
    instanceId Number
    The ID of the underlying Linode instance.
    status String
    The status of the node. (ready, not_ready)

    LkeClusterPoolTaint, LkeClusterPoolTaintArgs

    Effect string
    The Kubernetes taint effect.
    Key string
    The Kubernetes taint key.
    Value string
    The Kubernetes taint value.
    Effect string
    The Kubernetes taint effect.
    Key string
    The Kubernetes taint key.
    Value string
    The Kubernetes taint value.
    effect String
    The Kubernetes taint effect.
    key String
    The Kubernetes taint key.
    value String
    The Kubernetes taint value.
    effect string
    The Kubernetes taint effect.
    key string
    The Kubernetes taint key.
    value string
    The Kubernetes taint value.
    effect str
    The Kubernetes taint effect.
    key str
    The Kubernetes taint key.
    value str
    The Kubernetes taint value.
    effect String
    The Kubernetes taint effect.
    key String
    The Kubernetes taint key.
    value String
    The Kubernetes taint value.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi