KubernetesCluster

Provides a DigitalOcean Kubernetes cluster resource. This can be used to create, delete, and modify clusters. For more information see the official documentation.

Example Usage

Basic Example

using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new DigitalOcean.KubernetesCluster("foo", new DigitalOcean.KubernetesClusterArgs
        {
            NodePool = new DigitalOcean.Inputs.KubernetesClusterNodePoolArgs
            {
                Name = "worker-pool",
                NodeCount = 3,
                Size = "s-2vcpu-2gb",
            },
            Region = "nyc1",
            Version = "1.15.5-do.1",
        });
    }

}

Coming soon!

import pulumi
import pulumi_digitalocean as digitalocean

foo = digitalocean.KubernetesCluster("foo",
    node_pool={
        "name": "worker-pool",
        "node_count": 3,
        "size": "s-2vcpu-2gb",
    },
    region="nyc1",
    version="1.15.5-do.1")

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

const foo = new digitalocean.KubernetesCluster("foo", {
    nodePool: {
        name: "worker-pool",
        nodeCount: 3,
        size: "s-2vcpu-2gb",
    },
    region: "nyc1",
    // Grab the latest version slug from `doctl kubernetes options versions`
    version: "1.15.5-do.1",
});

Autoscaling Example

using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new DigitalOcean.KubernetesCluster("foo", new DigitalOcean.KubernetesClusterArgs
        {
            NodePool = new DigitalOcean.Inputs.KubernetesClusterNodePoolArgs
            {
                AutoScale = true,
                MaxNodes = 5,
                MinNodes = 1,
                Name = "autoscale-worker-pool",
                Size = "s-2vcpu-2gb",
            },
            Region = "nyc1",
            Version = "1.15.5-do.1",
        });
    }

}

Coming soon!

import pulumi
import pulumi_digitalocean as digitalocean

foo = digitalocean.KubernetesCluster("foo",
    node_pool={
        "auto_scale": True,
        "max_nodes": 5,
        "min_nodes": 1,
        "name": "autoscale-worker-pool",
        "size": "s-2vcpu-2gb",
    },
    region="nyc1",
    version="1.15.5-do.1")

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

const foo = new digitalocean.KubernetesCluster("foo", {
    nodePool: {
        autoScale: true,
        maxNodes: 5,
        minNodes: 1,
        name: "autoscale-worker-pool",
        size: "s-2vcpu-2gb",
    },
    region: "nyc1",
    version: "1.15.5-do.1",
});

Create a KubernetesCluster Resource

new KubernetesCluster(name: string, args: KubernetesClusterArgs, opts?: CustomResourceOptions);

def KubernetesCluster(resource_name, opts=None, name=None, node_pool=None, region=None, tags=None, version=None, vpc_uuid=None, __props__=None);

func NewKubernetesCluster(ctx *Context, name string, args KubernetesClusterArgs, opts ...ResourceOption) (*KubernetesCluster, error)

public KubernetesCluster(string name, KubernetesClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args KubernetesClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KubernetesClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KubernetesClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

KubernetesCluster Resource Properties

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

Inputs

The KubernetesCluster resource accepts the following input properties:

NodePool Pulumi.DigitalOcean.Inputs.KubernetesClusterNodePoolArgs: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
Region string: The slug identifier for the region where the Kubernetes cluster will be created.
Version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
Name string: A name for the Kubernetes cluster.
Tags List<string>: A list of tag names to be applied to the Kubernetes cluster.
VpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

NodePool KubernetesClusterNodePool: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
Region string: The slug identifier for the region where the Kubernetes cluster will be created.
Version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
Name string: A name for the Kubernetes cluster.
Tags []string: A list of tag names to be applied to the Kubernetes cluster.
VpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

nodePool KubernetesClusterNodePool: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
region Region: The slug identifier for the region where the Kubernetes cluster will be created.
version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
name string: A name for the Kubernetes cluster.
tags string[]: A list of tag names to be applied to the Kubernetes cluster.
vpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

node_pool Dict[KubernetesClusterNodePool]: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
region str: The slug identifier for the region where the Kubernetes cluster will be created.
version str: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
name str: A name for the Kubernetes cluster.
tags List[str]: A list of tag names to be applied to the Kubernetes cluster.
vpc_uuid str: The ID of the VPC where the Kubernetes cluster will be located.

Outputs

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

ClusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
CreatedAt string: The date and time when the Kubernetes cluster was created.
Endpoint string: The base URL of the API server on the Kubernetes master node.
Id string: The provider-assigned unique ID for this managed resource.
Ipv4Address string: The public IPv4 address of the Kubernetes master node.
KubeConfigs List<Pulumi.DigitalOcean.Outputs.KubernetesClusterKubeConfig>
ServiceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

ClusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
CreatedAt string: The date and time when the Kubernetes cluster was created.
Endpoint string: The base URL of the API server on the Kubernetes master node.
Id string: The provider-assigned unique ID for this managed resource.
Ipv4Address string: The public IPv4 address of the Kubernetes master node.
KubeConfigs []KubernetesClusterKubeConfig
ServiceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

clusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
createdAt string: The date and time when the Kubernetes cluster was created.
endpoint string: The base URL of the API server on the Kubernetes master node.
id string: The provider-assigned unique ID for this managed resource.
ipv4Address string: The public IPv4 address of the Kubernetes master node.
kubeConfigs KubernetesClusterKubeConfig[]
serviceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
updatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

cluster_subnet str: The range of IP addresses in the overlay network of the Kubernetes cluster.
created_at str: The date and time when the Kubernetes cluster was created.
endpoint str: The base URL of the API server on the Kubernetes master node.
id str: The provider-assigned unique ID for this managed resource.
ipv4_address str: The public IPv4 address of the Kubernetes master node.
kube_configs List[KubernetesClusterKubeConfig]
service_subnet str: The range of assignable IP addresses for services running in the Kubernetes cluster.
status str: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
updated_at str: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

Look up an Existing KubernetesCluster Resource

Get an existing KubernetesCluster 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?: KubernetesClusterState, opts?: CustomResourceOptions): KubernetesCluster

static get(resource_name, id, opts=None, cluster_subnet=None, created_at=None, endpoint=None, ipv4_address=None, kube_configs=None, name=None, node_pool=None, region=None, service_subnet=None, status=None, tags=None, updated_at=None, version=None, vpc_uuid=None, __props__=None);

func GetKubernetesCluster(ctx *Context, name string, id IDInput, state *KubernetesClusterState, opts ...ResourceOption) (*KubernetesCluster, error)

public static KubernetesCluster Get(string name, Input<string> id, KubernetesClusterState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

ClusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
CreatedAt string: The date and time when the Kubernetes cluster was created.
Endpoint string: The base URL of the API server on the Kubernetes master node.
Ipv4Address string: The public IPv4 address of the Kubernetes master node.
KubeConfigs List<Pulumi.DigitalOcean.Inputs.KubernetesClusterKubeConfigArgs>
Name string: A name for the Kubernetes cluster.
NodePool Pulumi.DigitalOcean.Inputs.KubernetesClusterNodePoolArgs: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
Region string: The slug identifier for the region where the Kubernetes cluster will be created.
ServiceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
Tags List<string>: A list of tag names to be applied to the Kubernetes cluster.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.
Version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
VpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

ClusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
CreatedAt string: The date and time when the Kubernetes cluster was created.
Endpoint string: The base URL of the API server on the Kubernetes master node.
Ipv4Address string: The public IPv4 address of the Kubernetes master node.
KubeConfigs []KubernetesClusterKubeConfig
Name string: A name for the Kubernetes cluster.
NodePool KubernetesClusterNodePool: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
Region string: The slug identifier for the region where the Kubernetes cluster will be created.
ServiceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
Tags []string: A list of tag names to be applied to the Kubernetes cluster.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.
Version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
VpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

clusterSubnet string: The range of IP addresses in the overlay network of the Kubernetes cluster.
createdAt string: The date and time when the Kubernetes cluster was created.
endpoint string: The base URL of the API server on the Kubernetes master node.
ipv4Address string: The public IPv4 address of the Kubernetes master node.
kubeConfigs KubernetesClusterKubeConfig[]
name string: A name for the Kubernetes cluster.
nodePool KubernetesClusterNodePool: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
region Region: The slug identifier for the region where the Kubernetes cluster will be created.
serviceSubnet string: The range of assignable IP addresses for services running in the Kubernetes cluster.
status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
tags string[]: A list of tag names to be applied to the Kubernetes cluster.
updatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.
version string: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
vpcUuid string: The ID of the VPC where the Kubernetes cluster will be located.

cluster_subnet str: The range of IP addresses in the overlay network of the Kubernetes cluster.
created_at str: The date and time when the Kubernetes cluster was created.
endpoint str: The base URL of the API server on the Kubernetes master node.
ipv4_address str: The public IPv4 address of the Kubernetes master node.
kube_configs List[KubernetesClusterKubeConfig]
name str: A name for the Kubernetes cluster.
node_pool Dict[KubernetesClusterNodePool]: A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the digitalocean..KubernetesNodePool resource. The following arguments may be specified: - name - (Required) A name for the node pool. - size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool. - node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value. - auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range. - min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to. - max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to. - tags - (Optional) A list of tag names to be applied to the Kubernetes cluster. - labels - (Optional) A map of key/value pairs to apply to nodes in the pool. The labels are exposed in the Kubernetes API as labels in the metadata of the corresponding Node resources.
region str: The slug identifier for the region where the Kubernetes cluster will be created.
service_subnet str: The range of assignable IP addresses for services running in the Kubernetes cluster.
status str: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
tags List[str]: A list of tag names to be applied to the Kubernetes cluster.
updated_at str: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.
version str: The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)
vpc_uuid str: The ID of the VPC where the Kubernetes cluster will be located.

Supporting Types

KubernetesClusterKubeConfig

See the output API doc for this type.

ClientCertificate string
ClientKey string
ClusterCaCertificate string
ExpiresAt string
Host string
RawConfig string
Token string

ClientCertificate string
ClientKey string
ClusterCaCertificate string
ExpiresAt string
Host string
RawConfig string
Token string

clientCertificate string
clientKey string
clusterCaCertificate string
expiresAt string
host string
rawConfig string
token string

clientCertificate str
clientKey str
clusterCaCertificate str
expiresAt str
host str
rawConfig str
token str

KubernetesClusterNodePool

See the input and output API doc for this type.

Name string: A name for the Kubernetes cluster.
Size string
ActualNodeCount int
AutoScale bool
Id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
Labels Dictionary<string, string>
MaxNodes int
MinNodes int
NodeCount int
Nodes List<Pulumi.DigitalOcean.Inputs.KubernetesClusterNodePoolNodeArgs>
Tags List<string>: A list of tag names to be applied to the Kubernetes cluster.

Name string: A name for the Kubernetes cluster.
Size string
ActualNodeCount int
AutoScale bool
Id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
Labels map[string]string
MaxNodes int
MinNodes int
NodeCount int
Nodes []KubernetesClusterNodePoolNode
Tags []string: A list of tag names to be applied to the Kubernetes cluster.

name string: A name for the Kubernetes cluster.
size string
actualNodeCount number
autoScale boolean
id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
labels {[key: string]: string}
maxNodes number
minNodes number
nodeCount number
nodes KubernetesClusterNodePoolNode[]
tags string[]: A list of tag names to be applied to the Kubernetes cluster.

name str: A name for the Kubernetes cluster.
size str
actual_node_count float
auto_scale bool
id str: A unique ID that can be used to identify and reference a Kubernetes cluster.
labels Dict[str, str]
max_nodes float
min_nodes float
node_count float
nodes List[KubernetesClusterNodePoolNode]
tags List[str]: A list of tag names to be applied to the Kubernetes cluster.

KubernetesClusterNodePoolNode

See the input and output API doc for this type.

CreatedAt string: The date and time when the Kubernetes cluster was created.
DropletId string
Id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
Name string: A name for the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

CreatedAt string: The date and time when the Kubernetes cluster was created.
DropletId string
Id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
Name string: A name for the Kubernetes cluster.
Status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
UpdatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

createdAt string: The date and time when the Kubernetes cluster was created.
dropletId string
id string: A unique ID that can be used to identify and reference a Kubernetes cluster.
name string: A name for the Kubernetes cluster.
status string: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
updatedAt string: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

created_at str: The date and time when the Kubernetes cluster was created.
droplet_id str
id str: A unique ID that can be used to identify and reference a Kubernetes cluster.
name str: A name for the Kubernetes cluster.
status str: A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
updated_at str: The date and time when the Kubernetes cluster was last updated. * kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes: - raw_config - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expires_at - The date and time when the credentials will expire and need to be regenerated.

Package Details

Repository: https://github.com/pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud