Docs Packages
  1. Packages
  2. DigitalOcean
  3. API Docs
  4. KubernetesCluster
DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi
pulumi/pulumi-digitalocean

digitalocean.KubernetesCluster

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi
pulumi/pulumi-digitalocean

    Import

    Before importing a Kubernetes cluster, the cluster’s default node pool must be tagged with

    the terraform:default-node-pool tag. The provider will automatically add this tag if

    the cluster only has a single node pool. Clusters with more than one node pool, however, will require

    that you manually add the terraform:default-node-pool tag to the node pool that you intend to be

    the default node pool.

    Then the Kubernetes cluster and its default node pool can be imported using the cluster’s id, e.g.

    $ pulumi import digitalocean:index/kubernetesCluster:KubernetesCluster mycluster 1b8b2100-0e9f-4e8f-ad78-9eb578c2a0af

    Additional node pools must be imported separately as digitalocean_kubernetes_cluster

    resources, e.g.

    $ pulumi import digitalocean:index/kubernetesCluster:KubernetesCluster mynodepool 9d76f410-9284-4436-9633-4066852442c8

    Create KubernetesCluster Resource

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

    Constructor syntax

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

@overload
def KubernetesCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      node_pool: Optional[KubernetesClusterNodePoolArgs] = None,
                      region: Optional[Union[str, Region]] = None,
                      version: Optional[str] = None,
                      auto_upgrade: Optional[bool] = None,
                      destroy_all_associated_resources: Optional[bool] = None,
                      ha: Optional[bool] = None,
                      maintenance_policy: Optional[KubernetesClusterMaintenancePolicyArgs] = None,
                      name: Optional[str] = None,
                      registry_integration: Optional[bool] = None,
                      surge_upgrade: Optional[bool] = None,
                      tags: Optional[Sequence[str]] = None,
                      vpc_uuid: Optional[str] = None)
    func NewKubernetesCluster(ctx *Context, name string, args KubernetesClusterArgs, opts ...ResourceOption) (*KubernetesCluster, error)
    public KubernetesCluster(string name, KubernetesClusterArgs args, CustomResourceOptions? opts = null)
    public KubernetesCluster(String name, KubernetesClusterArgs args)
public KubernetesCluster(String name, KubernetesClusterArgs args, CustomResourceOptions options)

    type: digitalocean:KubernetesCluster
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 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.
    args KubernetesClusterArgs
    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 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.
    name String
    The unique name of the resource.
    args KubernetesClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var kubernetesClusterResource = new DigitalOcean.KubernetesCluster("kubernetesClusterResource", new()
{
    NodePool = new DigitalOcean.Inputs.KubernetesClusterNodePoolArgs
    {
        Name = "string",
        Size = "string",
        ActualNodeCount = 0,
        AutoScale = false,
        Id = "string",
        Labels = 
        {
            { "string", "string" },
        },
        MaxNodes = 0,
        MinNodes = 0,
        NodeCount = 0,
        Nodes = new[]
        {
            new DigitalOcean.Inputs.KubernetesClusterNodePoolNodeArgs
            {
                CreatedAt = "string",
                DropletId = "string",
                Id = "string",
                Name = "string",
                Status = "string",
                UpdatedAt = "string",
            },
        },
        Tags = new[]
        {
            "string",
        },
        Taints = new[]
        {
            new DigitalOcean.Inputs.KubernetesClusterNodePoolTaintArgs
            {
                Effect = "string",
                Key = "string",
                Value = "string",
            },
        },
    },
    Region = "string",
    Version = "string",
    AutoUpgrade = false,
    DestroyAllAssociatedResources = false,
    Ha = false,
    MaintenancePolicy = new DigitalOcean.Inputs.KubernetesClusterMaintenancePolicyArgs
    {
        Day = "string",
        Duration = "string",
        StartTime = "string",
    },
    Name = "string",
    RegistryIntegration = false,
    SurgeUpgrade = false,
    Tags = new[]
    {
        "string",
    },
    VpcUuid = "string",
});

    example, err := digitalocean.NewKubernetesCluster(ctx, "kubernetesClusterResource", &digitalocean.KubernetesClusterArgs{
	NodePool: &digitalocean.KubernetesClusterNodePoolArgs{
		Name:            pulumi.String("string"),
		Size:            pulumi.String("string"),
		ActualNodeCount: pulumi.Int(0),
		AutoScale:       pulumi.Bool(false),
		Id:              pulumi.String("string"),
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		MaxNodes:  pulumi.Int(0),
		MinNodes:  pulumi.Int(0),
		NodeCount: pulumi.Int(0),
		Nodes: digitalocean.KubernetesClusterNodePoolNodeArray{
			&digitalocean.KubernetesClusterNodePoolNodeArgs{
				CreatedAt: pulumi.String("string"),
				DropletId: pulumi.String("string"),
				Id:        pulumi.String("string"),
				Name:      pulumi.String("string"),
				Status:    pulumi.String("string"),
				UpdatedAt: pulumi.String("string"),
			},
		},
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
		Taints: digitalocean.KubernetesClusterNodePoolTaintArray{
			&digitalocean.KubernetesClusterNodePoolTaintArgs{
				Effect: pulumi.String("string"),
				Key:    pulumi.String("string"),
				Value:  pulumi.String("string"),
			},
		},
	},
	Region:                        pulumi.String("string"),
	Version:                       pulumi.String("string"),
	AutoUpgrade:                   pulumi.Bool(false),
	DestroyAllAssociatedResources: pulumi.Bool(false),
	Ha:                            pulumi.Bool(false),
	MaintenancePolicy: &digitalocean.KubernetesClusterMaintenancePolicyArgs{
		Day:       pulumi.String("string"),
		Duration:  pulumi.String("string"),
		StartTime: pulumi.String("string"),
	},
	Name:                pulumi.String("string"),
	RegistryIntegration: pulumi.Bool(false),
	SurgeUpgrade:        pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcUuid: pulumi.String("string"),
})

    var kubernetesClusterResource = new KubernetesCluster("kubernetesClusterResource", KubernetesClusterArgs.builder()        
    .nodePool(KubernetesClusterNodePoolArgs.builder()
        .name("string")
        .size("string")
        .actualNodeCount(0)
        .autoScale(false)
        .id("string")
        .labels(Map.of("string", "string"))
        .maxNodes(0)
        .minNodes(0)
        .nodeCount(0)
        .nodes(KubernetesClusterNodePoolNodeArgs.builder()
            .createdAt("string")
            .dropletId("string")
            .id("string")
            .name("string")
            .status("string")
            .updatedAt("string")
            .build())
        .tags("string")
        .taints(KubernetesClusterNodePoolTaintArgs.builder()
            .effect("string")
            .key("string")
            .value("string")
            .build())
        .build())
    .region("string")
    .version("string")
    .autoUpgrade(false)
    .destroyAllAssociatedResources(false)
    .ha(false)
    .maintenancePolicy(KubernetesClusterMaintenancePolicyArgs.builder()
        .day("string")
        .duration("string")
        .startTime("string")
        .build())
    .name("string")
    .registryIntegration(false)
    .surgeUpgrade(false)
    .tags("string")
    .vpcUuid("string")
    .build());

    kubernetes_cluster_resource = digitalocean.KubernetesCluster("kubernetesClusterResource",
    node_pool=digitalocean.KubernetesClusterNodePoolArgs(
        name="string",
        size="string",
        actual_node_count=0,
        auto_scale=False,
        id="string",
        labels={
            "string": "string",
        },
        max_nodes=0,
        min_nodes=0,
        node_count=0,
        nodes=[digitalocean.KubernetesClusterNodePoolNodeArgs(
            created_at="string",
            droplet_id="string",
            id="string",
            name="string",
            status="string",
            updated_at="string",
        )],
        tags=["string"],
        taints=[digitalocean.KubernetesClusterNodePoolTaintArgs(
            effect="string",
            key="string",
            value="string",
        )],
    ),
    region="string",
    version="string",
    auto_upgrade=False,
    destroy_all_associated_resources=False,
    ha=False,
    maintenance_policy=digitalocean.KubernetesClusterMaintenancePolicyArgs(
        day="string",
        duration="string",
        start_time="string",
    ),
    name="string",
    registry_integration=False,
    surge_upgrade=False,
    tags=["string"],
    vpc_uuid="string")

    const kubernetesClusterResource = new digitalocean.KubernetesCluster("kubernetesClusterResource", {
    nodePool: {
        name: "string",
        size: "string",
        actualNodeCount: 0,
        autoScale: false,
        id: "string",
        labels: {
            string: "string",
        },
        maxNodes: 0,
        minNodes: 0,
        nodeCount: 0,
        nodes: [{
            createdAt: "string",
            dropletId: "string",
            id: "string",
            name: "string",
            status: "string",
            updatedAt: "string",
        }],
        tags: ["string"],
        taints: [{
            effect: "string",
            key: "string",
            value: "string",
        }],
    },
    region: "string",
    version: "string",
    autoUpgrade: false,
    destroyAllAssociatedResources: false,
    ha: false,
    maintenancePolicy: {
        day: "string",
        duration: "string",
        startTime: "string",
    },
    name: "string",
    registryIntegration: false,
    surgeUpgrade: false,
    tags: ["string"],
    vpcUuid: "string",
});

    type: digitalocean:KubernetesCluster
properties:
    autoUpgrade: false
    destroyAllAssociatedResources: false
    ha: false
    maintenancePolicy:
        day: string
        duration: string
        startTime: string
    name: string
    nodePool:
        actualNodeCount: 0
        autoScale: false
        id: string
        labels:
            string: string
        maxNodes: 0
        minNodes: 0
        name: string
        nodeCount: 0
        nodes:
            - createdAt: string
              dropletId: string
              id: string
              name: string
              status: string
              updatedAt: string
        size: string
        tags:
            - string
        taints:
            - effect: string
              key: string
              value: string
    region: string
    registryIntegration: false
    surgeUpgrade: false
    tags:
        - string
    version: string
    vpcUuid: string

    KubernetesCluster Resource Properties

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

    Inputs

    The KubernetesCluster resource accepts the following input properties:

    NodePool Pulumi.DigitalOcean.Inputs.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:
    Region string | Pulumi.DigitalOcean.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.)
    AutoUpgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    DestroyAllAssociatedResources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    Ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    MaintenancePolicy Pulumi.DigitalOcean.Inputs.KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    Name string
    A name for the node pool.
    RegistryIntegration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    SurgeUpgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    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 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:
    Region string | 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.)
    AutoUpgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    DestroyAllAssociatedResources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    Ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    MaintenancePolicy KubernetesClusterMaintenancePolicyArgs
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    Name string
    A name for the node pool.
    RegistryIntegration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    SurgeUpgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    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:
    region String | 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.)
    autoUpgrade Boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    destroyAllAssociatedResources Boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    ha Boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    maintenancePolicy KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name String
    A name for the node pool.
    registryIntegration Boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    surgeUpgrade Boolean
    Enable/disable surge upgrades for a cluster. Default: false
    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:
    region string | 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.)
    autoUpgrade boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    destroyAllAssociatedResources boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    ha boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    maintenancePolicy KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name string
    A name for the node pool.
    registryIntegration boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    surgeUpgrade boolean
    Enable/disable surge upgrades for a cluster. Default: false
    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 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:
    region str | Region
    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.)
    auto_upgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    destroy_all_associated_resources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    maintenance_policy KubernetesClusterMaintenancePolicyArgs
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name str
    A name for the node pool.
    registry_integration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    surge_upgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    tags Sequence[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.
    nodePool Property Map
    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:
    region String | "nyc1" | "nyc2" | "nyc3" | "sgp1" | "lon1" | "ams2" | "ams3" | "fra1" | "tor1" | "sfo1" | "sfo2" | "sfo3" | "blr1" | "syd1"
    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.)
    autoUpgrade Boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    destroyAllAssociatedResources Boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    ha Boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    maintenancePolicy Property Map
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name String
    A name for the node pool.
    registryIntegration Boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    surgeUpgrade Boolean
    Enable/disable surge upgrades for a cluster. Default: false
    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.

    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.
    ClusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    CreatedAt string
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    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 individual node.
    UpdatedAt string
    The date and time when the node was last updated.
    ClusterSubnet string
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    ClusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    CreatedAt string
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    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 individual node.
    UpdatedAt string
    The date and time when the node was last updated.
    clusterSubnet String
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn String
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt String
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    kubeConfigs List<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 individual node.
    updatedAt String
    The date and time when the node was last updated.
    clusterSubnet string
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt string
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    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 individual node.
    updatedAt string
    The date and time when the node was last updated.
    cluster_subnet str
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    cluster_urn str
    The uniform resource name (URN) for the Kubernetes cluster.
    created_at str
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    kube_configs Sequence[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 individual node.
    updated_at str
    The date and time when the node was last updated.
    clusterSubnet String
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn String
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt String
    The date and time when the node 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. This will not be set if high availability is configured on the cluster (v1.21+)
    kubeConfigs List<Property Map>
    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 individual node.
    updatedAt String
    The date and time when the node was last updated.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_upgrade: Optional[bool] = None,
        cluster_subnet: Optional[str] = None,
        cluster_urn: Optional[str] = None,
        created_at: Optional[str] = None,
        destroy_all_associated_resources: Optional[bool] = None,
        endpoint: Optional[str] = None,
        ha: Optional[bool] = None,
        ipv4_address: Optional[str] = None,
        kube_configs: Optional[Sequence[KubernetesClusterKubeConfigArgs]] = None,
        maintenance_policy: Optional[KubernetesClusterMaintenancePolicyArgs] = None,
        name: Optional[str] = None,
        node_pool: Optional[KubernetesClusterNodePoolArgs] = None,
        region: Optional[Union[str, Region]] = None,
        registry_integration: Optional[bool] = None,
        service_subnet: Optional[str] = None,
        status: Optional[str] = None,
        surge_upgrade: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        version: Optional[str] = None,
        vpc_uuid: Optional[str] = None) -> KubernetesCluster
    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)
    public static KubernetesCluster get(String name, Output<String> id, KubernetesClusterState 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:
    AutoUpgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    ClusterSubnet string
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    ClusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    CreatedAt string
    The date and time when the node was created.
    DestroyAllAssociatedResources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    Endpoint string
    The base URL of the API server on the Kubernetes master node.
    Ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    Ipv4Address string
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    KubeConfigs List<Pulumi.DigitalOcean.Inputs.KubernetesClusterKubeConfig>
    MaintenancePolicy Pulumi.DigitalOcean.Inputs.KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    Name string
    A name for the node pool.
    NodePool Pulumi.DigitalOcean.Inputs.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:
    Region string | Pulumi.DigitalOcean.Region
    The slug identifier for the region where the Kubernetes cluster will be created.
    RegistryIntegration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    SurgeUpgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    Tags List<string>
    A list of tag names to be applied to the Kubernetes cluster.
    UpdatedAt string
    The date and time when the node was last updated.
    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.
    AutoUpgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    ClusterSubnet string
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    ClusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    CreatedAt string
    The date and time when the node was created.
    DestroyAllAssociatedResources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    Endpoint string
    The base URL of the API server on the Kubernetes master node.
    Ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    Ipv4Address string
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    KubeConfigs []KubernetesClusterKubeConfigArgs
    MaintenancePolicy KubernetesClusterMaintenancePolicyArgs
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    Name string
    A name for the node pool.
    NodePool 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:
    Region string | Region
    The slug identifier for the region where the Kubernetes cluster will be created.
    RegistryIntegration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    SurgeUpgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    Tags []string
    A list of tag names to be applied to the Kubernetes cluster.
    UpdatedAt string
    The date and time when the node was last updated.
    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.
    autoUpgrade Boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    clusterSubnet String
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn String
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt String
    The date and time when the node was created.
    destroyAllAssociatedResources Boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    endpoint String
    The base URL of the API server on the Kubernetes master node.
    ha Boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    ipv4Address String
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    kubeConfigs List<KubernetesClusterKubeConfig>
    maintenancePolicy KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name String
    A name for the node pool.
    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:
    region String | Region
    The slug identifier for the region where the Kubernetes cluster will be created.
    registryIntegration Boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    surgeUpgrade Boolean
    Enable/disable surge upgrades for a cluster. Default: false
    tags List<String>
    A list of tag names to be applied to the Kubernetes cluster.
    updatedAt String
    The date and time when the node was last updated.
    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.
    autoUpgrade boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    clusterSubnet string
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn string
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt string
    The date and time when the node was created.
    destroyAllAssociatedResources boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    endpoint string
    The base URL of the API server on the Kubernetes master node.
    ha boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    ipv4Address string
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    kubeConfigs KubernetesClusterKubeConfig[]
    maintenancePolicy KubernetesClusterMaintenancePolicy
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name string
    A name for the node pool.
    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:
    region string | Region
    The slug identifier for the region where the Kubernetes cluster will be created.
    registryIntegration boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    surgeUpgrade boolean
    Enable/disable surge upgrades for a cluster. Default: false
    tags string[]
    A list of tag names to be applied to the Kubernetes cluster.
    updatedAt string
    The date and time when the node was last updated.
    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.
    auto_upgrade bool
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    cluster_subnet str
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    cluster_urn str
    The uniform resource name (URN) for the Kubernetes cluster.
    created_at str
    The date and time when the node was created.
    destroy_all_associated_resources bool

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    endpoint str
    The base URL of the API server on the Kubernetes master node.
    ha bool
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    ipv4_address str
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    kube_configs Sequence[KubernetesClusterKubeConfigArgs]
    maintenance_policy KubernetesClusterMaintenancePolicyArgs
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name str
    A name for the node pool.
    node_pool 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:
    region str | Region
    The slug identifier for the region where the Kubernetes cluster will be created.
    registry_integration bool
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    surge_upgrade bool
    Enable/disable surge upgrades for a cluster. Default: false
    tags Sequence[str]
    A list of tag names to be applied to the Kubernetes cluster.
    updated_at str
    The date and time when the node was last updated.
    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.
    autoUpgrade Boolean
    A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window.
    clusterSubnet String
    The range of IP addresses in the overlay network of the Kubernetes cluster.
    clusterUrn String
    The uniform resource name (URN) for the Kubernetes cluster.
    createdAt String
    The date and time when the node was created.
    destroyAllAssociatedResources Boolean

    Use with caution. When set to true, all associated DigitalOcean resources created via the Kubernetes API (load balancers, volumes, and volume snapshots) will be destroyed along with the cluster when it is destroyed.

    This resource supports customized create timeouts. The default timeout is 30 minutes.

    endpoint String
    The base URL of the API server on the Kubernetes master node.
    ha Boolean
    Enable/disable the high availability control plane for a cluster. Once enabled for a cluster, high availability cannot be disabled. Default: false
    ipv4Address String
    The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+)
    kubeConfigs List<Property Map>
    maintenancePolicy Property Map
    A block representing the cluster's maintenance window. Updates will be applied within this window. If not specified, a default maintenance window will be chosen. auto_upgrade must be set to true for this to have an effect.
    name String
    A name for the node pool.
    nodePool Property Map
    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:
    region String | "nyc1" | "nyc2" | "nyc3" | "sgp1" | "lon1" | "ams2" | "ams3" | "fra1" | "tor1" | "sfo1" | "sfo2" | "sfo3" | "blr1" | "syd1"
    The slug identifier for the region where the Kubernetes cluster will be created.
    registryIntegration Boolean
    Enables or disables the DigitalOcean container registry integration for the cluster. This requires that a container registry has first been created for the account. Default: false
    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 individual node.
    surgeUpgrade Boolean
    Enable/disable surge upgrades for a cluster. Default: false
    tags List<String>
    A list of tag names to be applied to the Kubernetes cluster.
    updatedAt String
    The date and time when the node was last updated.
    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.

    Supporting Types

    KubernetesClusterKubeConfig, KubernetesClusterKubeConfigArgs

    ClientCertificate string
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    ClientKey string
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    ClusterCaCertificate string
    The base64 encoded public certificate for the cluster's certificate authority.
    ExpiresAt string
    The date and time when the credentials will expire and need to be regenerated.
    Host string
    The URL of the API server on the Kubernetes master node.
    RawConfig string
    The full contents of the Kubernetes cluster's kubeconfig file.
    Token string
    The DigitalOcean API access token used by clients to access the cluster.
    ClientCertificate string
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    ClientKey string
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    ClusterCaCertificate string
    The base64 encoded public certificate for the cluster's certificate authority.
    ExpiresAt string
    The date and time when the credentials will expire and need to be regenerated.
    Host string
    The URL of the API server on the Kubernetes master node.
    RawConfig string
    The full contents of the Kubernetes cluster's kubeconfig file.
    Token string
    The DigitalOcean API access token used by clients to access the cluster.
    clientCertificate String
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clientKey String
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clusterCaCertificate String
    The base64 encoded public certificate for the cluster's certificate authority.
    expiresAt String
    The date and time when the credentials will expire and need to be regenerated.
    host String
    The URL of the API server on the Kubernetes master node.
    rawConfig String
    The full contents of the Kubernetes cluster's kubeconfig file.
    token String
    The DigitalOcean API access token used by clients to access the cluster.
    clientCertificate string
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clientKey string
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clusterCaCertificate string
    The base64 encoded public certificate for the cluster's certificate authority.
    expiresAt string
    The date and time when the credentials will expire and need to be regenerated.
    host string
    The URL of the API server on the Kubernetes master node.
    rawConfig string
    The full contents of the Kubernetes cluster's kubeconfig file.
    token string
    The DigitalOcean API access token used by clients to access the cluster.
    client_certificate str
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    client_key str
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    cluster_ca_certificate str
    The base64 encoded public certificate for the cluster's certificate authority.
    expires_at str
    The date and time when the credentials will expire and need to be regenerated.
    host str
    The URL of the API server on the Kubernetes master node.
    raw_config str
    The full contents of the Kubernetes cluster's kubeconfig file.
    token str
    The DigitalOcean API access token used by clients to access the cluster.
    clientCertificate String
    The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clientKey String
    The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
    clusterCaCertificate String
    The base64 encoded public certificate for the cluster's certificate authority.
    expiresAt String
    The date and time when the credentials will expire and need to be regenerated.
    host String
    The URL of the API server on the Kubernetes master node.
    rawConfig String
    The full contents of the Kubernetes cluster's kubeconfig file.
    token String
    The DigitalOcean API access token used by clients to access the cluster.

    KubernetesClusterMaintenancePolicy, KubernetesClusterMaintenancePolicyArgs

    Day string
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    Duration string
    A string denoting the duration of the service window, e.g., "04:00".
    StartTime string
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).
    Day string
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    Duration string
    A string denoting the duration of the service window, e.g., "04:00".
    StartTime string
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).
    day String
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    duration String
    A string denoting the duration of the service window, e.g., "04:00".
    startTime String
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).
    day string
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    duration string
    A string denoting the duration of the service window, e.g., "04:00".
    startTime string
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).
    day str
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    duration str
    A string denoting the duration of the service window, e.g., "04:00".
    start_time str
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).
    day String
    The day of the maintenance window policy. May be one of "monday" through "sunday", or "any" to indicate an arbitrary week day.
    duration String
    A string denoting the duration of the service window, e.g., "04:00".
    startTime String
    The start time in UTC of the maintenance window policy in 24-hour clock format / HH:MM notation (e.g., 15:00).

    KubernetesClusterNodePool, KubernetesClusterNodePoolArgs

    Name string
    A name for the node pool.
    Size string
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    ActualNodeCount int
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    AutoScale bool
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    Id string
    A unique ID that can be used to identify and reference the node.
    Labels Dictionary<string, string>
    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.
    MaxNodes int
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    MinNodes int
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    NodeCount int
    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.
    Nodes List<Pulumi.DigitalOcean.Inputs.KubernetesClusterNodePoolNode>
    A list of nodes in the pool. Each node exports the following attributes:
    Tags List<string>
    A list of tag names to be applied to the Kubernetes cluster.
    Taints List<Pulumi.DigitalOcean.Inputs.KubernetesClusterNodePoolTaint>
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):
    Name string
    A name for the node pool.
    Size string
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    ActualNodeCount int
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    AutoScale bool
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    Id string
    A unique ID that can be used to identify and reference the node.
    Labels map[string]string
    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.
    MaxNodes int
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    MinNodes int
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    NodeCount int
    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.
    Nodes []KubernetesClusterNodePoolNode
    A list of nodes in the pool. Each node exports the following attributes:
    Tags []string
    A list of tag names to be applied to the Kubernetes cluster.
    Taints []KubernetesClusterNodePoolTaint
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):
    name String
    A name for the node pool.
    size String
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    actualNodeCount Integer
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    autoScale Boolean
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    id String
    A unique ID that can be used to identify and reference the node.
    labels Map<String,String>
    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.
    maxNodes Integer
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    minNodes Integer
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    nodeCount Integer
    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.
    nodes List<KubernetesClusterNodePoolNode>
    A list of nodes in the pool. Each node exports the following attributes:
    tags List<String>
    A list of tag names to be applied to the Kubernetes cluster.
    taints List<KubernetesClusterNodePoolTaint>
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):
    name string
    A name for the node pool.
    size string
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    actualNodeCount number
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    autoScale boolean
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    id string
    A unique ID that can be used to identify and reference the node.
    labels {[key: string]: string}
    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.
    maxNodes number
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    minNodes number
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    nodeCount number
    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.
    nodes KubernetesClusterNodePoolNode[]
    A list of nodes in the pool. Each node exports the following attributes:
    tags string[]
    A list of tag names to be applied to the Kubernetes cluster.
    taints KubernetesClusterNodePoolTaint[]
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):
    name str
    A name for the node pool.
    size str
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    actual_node_count int
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    auto_scale bool
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    id str
    A unique ID that can be used to identify and reference the node.
    labels Mapping[str, str]
    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.
    max_nodes int
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    min_nodes int
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    node_count int
    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.
    nodes Sequence[KubernetesClusterNodePoolNode]
    A list of nodes in the pool. Each node exports the following attributes:
    tags Sequence[str]
    A list of tag names to be applied to the Kubernetes cluster.
    taints Sequence[KubernetesClusterNodePoolTaint]
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):
    name String
    A name for the node pool.
    size String
    The slug identifier for the type of Droplet to be used as workers in the node pool.
    actualNodeCount Number
    A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.
    autoScale Boolean
    Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
    id String
    A unique ID that can be used to identify and reference the node.
    labels Map<String>
    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.
    maxNodes Number
    If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
    minNodes Number
    If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
    nodeCount Number
    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.
    nodes List<Property Map>
    A list of nodes in the pool. Each node exports the following attributes:
    tags List<String>
    A list of tag names to be applied to the Kubernetes cluster.
    taints List<Property Map>
    A block representing a taint applied to all nodes in the pool. Each taint exports the following attributes (taints must be unique by key and effect pair):

    KubernetesClusterNodePoolNode, KubernetesClusterNodePoolNodeArgs

    CreatedAt string
    The date and time when the node was created.
    DropletId string
    The id of the node's droplet
    Id string
    A unique ID that can be used to identify and reference the node.
    Name string
    A name for the node pool.
    Status string
    A string indicating the current status of the individual node.
    UpdatedAt string
    The date and time when the node was last updated.
    CreatedAt string
    The date and time when the node was created.
    DropletId string
    The id of the node's droplet
    Id string
    A unique ID that can be used to identify and reference the node.
    Name string
    A name for the node pool.
    Status string
    A string indicating the current status of the individual node.
    UpdatedAt string
    The date and time when the node was last updated.
    createdAt String
    The date and time when the node was created.
    dropletId String
    The id of the node's droplet
    id String
    A unique ID that can be used to identify and reference the node.
    name String
    A name for the node pool.
    status String
    A string indicating the current status of the individual node.
    updatedAt String
    The date and time when the node was last updated.
    createdAt string
    The date and time when the node was created.
    dropletId string
    The id of the node's droplet
    id string
    A unique ID that can be used to identify and reference the node.
    name string
    A name for the node pool.
    status string
    A string indicating the current status of the individual node.
    updatedAt string
    The date and time when the node was last updated.
    created_at str
    The date and time when the node was created.
    droplet_id str
    The id of the node's droplet
    id str
    A unique ID that can be used to identify and reference the node.
    name str
    A name for the node pool.
    status str
    A string indicating the current status of the individual node.
    updated_at str
    The date and time when the node was last updated.
    createdAt String
    The date and time when the node was created.
    dropletId String
    The id of the node's droplet
    id String
    A unique ID that can be used to identify and reference the node.
    name String
    A name for the node pool.
    status String
    A string indicating the current status of the individual node.
    updatedAt String
    The date and time when the node was last updated.

    KubernetesClusterNodePoolTaint, KubernetesClusterNodePoolTaintArgs

    Effect string
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    Key string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    Value string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    Effect string
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    Key string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    Value string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    effect String
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    key String
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    value String
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    effect string
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    key string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    value string
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    effect str
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    key str
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    value str
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    effect String
    How the node reacts to pods that it won't tolerate. Available effect values are: "NoSchedule", "PreferNoSchedule", "NoExecute".
    key String
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.
    value String
    An arbitrary string. The "key" and "value" fields of the "taint" object form a key-value pair.

    Region, RegionArgs

    NYC1
    nyc1
    NYC2
    nyc2
    NYC3
    nyc3
    SGP1
    sgp1
    LON1
    lon1
    AMS2
    ams2
    AMS3
    ams3
    FRA1
    fra1
    TOR1
    tor1
    SFO1
    sfo1
    SFO2
    sfo2
    SFO3
    sfo3
    BLR1
    blr1
    SYD1
    syd1
    RegionNYC1
    nyc1
    RegionNYC2
    nyc2
    RegionNYC3
    nyc3
    RegionSGP1
    sgp1
    RegionLON1
    lon1
    RegionAMS2
    ams2
    RegionAMS3
    ams3
    RegionFRA1
    fra1
    RegionTOR1
    tor1
    RegionSFO1
    sfo1
    RegionSFO2
    sfo2
    RegionSFO3
    sfo3
    RegionBLR1
    blr1
    RegionSYD1
    syd1
    NYC1
    nyc1
    NYC2
    nyc2
    NYC3
    nyc3
    SGP1
    sgp1
    LON1
    lon1
    AMS2
    ams2
    AMS3
    ams3
    FRA1
    fra1
    TOR1
    tor1
    SFO1
    sfo1
    SFO2
    sfo2
    SFO3
    sfo3
    BLR1
    blr1
    SYD1
    syd1
    NYC1
    nyc1
    NYC2
    nyc2
    NYC3
    nyc3
    SGP1
    sgp1
    LON1
    lon1
    AMS2
    ams2
    AMS3
    ams3
    FRA1
    fra1
    TOR1
    tor1
    SFO1
    sfo1
    SFO2
    sfo2
    SFO3
    sfo3
    BLR1
    blr1
    SYD1
    syd1
    NYC1
    nyc1
    NYC2
    nyc2
    NYC3
    nyc3
    SGP1
    sgp1
    LON1
    lon1
    AMS2
    ams2
    AMS3
    ams3
    FRA1
    fra1
    TOR1
    tor1
    SFO1
    sfo1
    SFO2
    sfo2
    SFO3
    sfo3
    BLR1
    blr1
    SYD1
    syd1
    "nyc1"
    nyc1
    "nyc2"
    nyc2
    "nyc3"
    nyc3
    "sgp1"
    sgp1
    "lon1"
    lon1
    "ams2"
    ams2
    "ams3"
    ams3
    "fra1"
    fra1
    "tor1"
    tor1
    "sfo1"
    sfo1
    "sfo2"
    sfo2
    "sfo3"
    sfo3
    "blr1"
    blr1
    "syd1"
    syd1

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi
    pulumi/pulumi-digitalocean