Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ContainerEngine
  5. Cluster
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.ContainerEngine.Cluster

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Cluster resource in Oracle Cloud Infrastructure Container Engine service.

Create a new cluster.

Example Usage

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

const testCluster = new oci.containerengine.Cluster("test_cluster", {
    compartmentId: compartmentId,
    kubernetesVersion: clusterKubernetesVersion,
    name: clusterName,
    vcnId: testVcn.id,
    clusterPodNetworkOptions: [{
        cniType: clusterClusterPodNetworkOptionsCniType,
    }],
    definedTags: {
        "Operations.CostCenter": "42",
    },
    endpointConfig: {
        isPublicIpEnabled: clusterEndpointConfigIsPublicIpEnabled,
        nsgIds: clusterEndpointConfigNsgIds,
        subnetId: testSubnet.id,
    },
    freeformTags: {
        Department: "Finance",
    },
    imagePolicyConfig: {
        isPolicyEnabled: clusterImagePolicyConfigIsPolicyEnabled,
        keyDetails: [{
            kmsKeyId: testKey.id,
        }],
    },
    kmsKeyId: testKey.id,
    options: {
        addOns: {
            isKubernetesDashboardEnabled: clusterOptionsAddOnsIsKubernetesDashboardEnabled,
            isTillerEnabled: clusterOptionsAddOnsIsTillerEnabled,
        },
        admissionControllerOptions: {
            isPodSecurityPolicyEnabled: clusterOptionsAdmissionControllerOptionsIsPodSecurityPolicyEnabled,
        },
        ipFamilies: clusterOptionsIpFamilies,
        kubernetesNetworkConfig: {
            podsCidr: clusterOptionsKubernetesNetworkConfigPodsCidr,
            servicesCidr: clusterOptionsKubernetesNetworkConfigServicesCidr,
        },
        openIdConnectTokenAuthenticationConfig: {
            isOpenIdConnectAuthEnabled: clusterOptionsOpenIdConnectTokenAuthenticationConfigIsOpenIdConnectAuthEnabled,
            caCertificate: clusterOptionsOpenIdConnectTokenAuthenticationConfigCaCertificate,
            clientId: testClient.id,
            configurationFile: clusterOptionsOpenIdConnectTokenAuthenticationConfigConfigurationFile,
            groupsClaim: clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsClaim,
            groupsPrefix: clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsPrefix,
            issuerUrl: clusterOptionsOpenIdConnectTokenAuthenticationConfigIssuerUrl,
            requiredClaims: [{
                key: clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsKey,
                value: clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsValue,
            }],
            signingAlgorithms: clusterOptionsOpenIdConnectTokenAuthenticationConfigSigningAlgorithms,
            usernameClaim: clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernameClaim,
            usernamePrefix: clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernamePrefix,
        },
        openIdConnectDiscovery: {
            isOpenIdConnectDiscoveryEnabled: clusterOptionsOpenIdConnectDiscoveryIsOpenIdConnectDiscoveryEnabled,
        },
        persistentVolumeConfig: {
            definedTags: {
                "Operations.CostCenter": "42",
            },
            freeformTags: {
                Department: "Finance",
            },
        },
        serviceLbConfig: {
            definedTags: {
                "Operations.CostCenter": "42",
            },
            freeformTags: {
                Department: "Finance",
            },
        },
        serviceLbSubnetIds: clusterOptionsServiceLbSubnetIds,
    },
    type: clusterType,
});
Copy
import pulumi
import pulumi_oci as oci

test_cluster = oci.container_engine.Cluster("test_cluster",
    compartment_id=compartment_id,
    kubernetes_version=cluster_kubernetes_version,
    name=cluster_name,
    vcn_id=test_vcn["id"],
    cluster_pod_network_options=[{
        "cni_type": cluster_cluster_pod_network_options_cni_type,
    }],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    endpoint_config={
        "is_public_ip_enabled": cluster_endpoint_config_is_public_ip_enabled,
        "nsg_ids": cluster_endpoint_config_nsg_ids,
        "subnet_id": test_subnet["id"],
    },
    freeform_tags={
        "Department": "Finance",
    },
    image_policy_config={
        "is_policy_enabled": cluster_image_policy_config_is_policy_enabled,
        "key_details": [{
            "kms_key_id": test_key["id"],
        }],
    },
    kms_key_id=test_key["id"],
    options={
        "add_ons": {
            "is_kubernetes_dashboard_enabled": cluster_options_add_ons_is_kubernetes_dashboard_enabled,
            "is_tiller_enabled": cluster_options_add_ons_is_tiller_enabled,
        },
        "admission_controller_options": {
            "is_pod_security_policy_enabled": cluster_options_admission_controller_options_is_pod_security_policy_enabled,
        },
        "ip_families": cluster_options_ip_families,
        "kubernetes_network_config": {
            "pods_cidr": cluster_options_kubernetes_network_config_pods_cidr,
            "services_cidr": cluster_options_kubernetes_network_config_services_cidr,
        },
        "open_id_connect_token_authentication_config": {
            "is_open_id_connect_auth_enabled": cluster_options_open_id_connect_token_authentication_config_is_open_id_connect_auth_enabled,
            "ca_certificate": cluster_options_open_id_connect_token_authentication_config_ca_certificate,
            "client_id": test_client["id"],
            "configuration_file": cluster_options_open_id_connect_token_authentication_config_configuration_file,
            "groups_claim": cluster_options_open_id_connect_token_authentication_config_groups_claim,
            "groups_prefix": cluster_options_open_id_connect_token_authentication_config_groups_prefix,
            "issuer_url": cluster_options_open_id_connect_token_authentication_config_issuer_url,
            "required_claims": [{
                "key": cluster_options_open_id_connect_token_authentication_config_required_claims_key,
                "value": cluster_options_open_id_connect_token_authentication_config_required_claims_value,
            }],
            "signing_algorithms": cluster_options_open_id_connect_token_authentication_config_signing_algorithms,
            "username_claim": cluster_options_open_id_connect_token_authentication_config_username_claim,
            "username_prefix": cluster_options_open_id_connect_token_authentication_config_username_prefix,
        },
        "open_id_connect_discovery": {
            "is_open_id_connect_discovery_enabled": cluster_options_open_id_connect_discovery_is_open_id_connect_discovery_enabled,
        },
        "persistent_volume_config": {
            "defined_tags": {
                "Operations.CostCenter": "42",
            },
            "freeform_tags": {
                "Department": "Finance",
            },
        },
        "service_lb_config": {
            "defined_tags": {
                "Operations.CostCenter": "42",
            },
            "freeform_tags": {
                "Department": "Finance",
            },
        },
        "service_lb_subnet_ids": cluster_options_service_lb_subnet_ids,
    },
    type=cluster_type)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/containerengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerengine.NewCluster(ctx, "test_cluster", &containerengine.ClusterArgs{
			CompartmentId:     pulumi.Any(compartmentId),
			KubernetesVersion: pulumi.Any(clusterKubernetesVersion),
			Name:              pulumi.Any(clusterName),
			VcnId:             pulumi.Any(testVcn.Id),
			ClusterPodNetworkOptions: containerengine.ClusterClusterPodNetworkOptionArray{
				&containerengine.ClusterClusterPodNetworkOptionArgs{
					CniType: pulumi.Any(clusterClusterPodNetworkOptionsCniType),
				},
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			EndpointConfig: &containerengine.ClusterEndpointConfigArgs{
				IsPublicIpEnabled: pulumi.Any(clusterEndpointConfigIsPublicIpEnabled),
				NsgIds:            pulumi.Any(clusterEndpointConfigNsgIds),
				SubnetId:          pulumi.Any(testSubnet.Id),
			},
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			ImagePolicyConfig: &containerengine.ClusterImagePolicyConfigArgs{
				IsPolicyEnabled: pulumi.Any(clusterImagePolicyConfigIsPolicyEnabled),
				KeyDetails: containerengine.ClusterImagePolicyConfigKeyDetailArray{
					&containerengine.ClusterImagePolicyConfigKeyDetailArgs{
						KmsKeyId: pulumi.Any(testKey.Id),
					},
				},
			},
			KmsKeyId: pulumi.Any(testKey.Id),
			Options: &containerengine.ClusterOptionsArgs{
				AddOns: &containerengine.ClusterOptionsAddOnsArgs{
					IsKubernetesDashboardEnabled: pulumi.Any(clusterOptionsAddOnsIsKubernetesDashboardEnabled),
					IsTillerEnabled:              pulumi.Any(clusterOptionsAddOnsIsTillerEnabled),
				},
				AdmissionControllerOptions: &containerengine.ClusterOptionsAdmissionControllerOptionsArgs{
					IsPodSecurityPolicyEnabled: pulumi.Any(clusterOptionsAdmissionControllerOptionsIsPodSecurityPolicyEnabled),
				},
				IpFamilies: pulumi.Any(clusterOptionsIpFamilies),
				KubernetesNetworkConfig: &containerengine.ClusterOptionsKubernetesNetworkConfigArgs{
					PodsCidr:     pulumi.Any(clusterOptionsKubernetesNetworkConfigPodsCidr),
					ServicesCidr: pulumi.Any(clusterOptionsKubernetesNetworkConfigServicesCidr),
				},
				OpenIdConnectTokenAuthenticationConfig: &containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs{
					IsOpenIdConnectAuthEnabled: pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigIsOpenIdConnectAuthEnabled),
					CaCertificate:              pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigCaCertificate),
					ClientId:                   pulumi.Any(testClient.Id),
					ConfigurationFile:          pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigConfigurationFile),
					GroupsClaim:                pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsClaim),
					GroupsPrefix:               pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsPrefix),
					IssuerUrl:                  pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigIssuerUrl),
					RequiredClaims: containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArray{
						&containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs{
							Key:   pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsKey),
							Value: pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsValue),
						},
					},
					SigningAlgorithms: pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigSigningAlgorithms),
					UsernameClaim:     pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernameClaim),
					UsernamePrefix:    pulumi.Any(clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernamePrefix),
				},
				OpenIdConnectDiscovery: &containerengine.ClusterOptionsOpenIdConnectDiscoveryArgs{
					IsOpenIdConnectDiscoveryEnabled: pulumi.Any(clusterOptionsOpenIdConnectDiscoveryIsOpenIdConnectDiscoveryEnabled),
				},
				PersistentVolumeConfig: &containerengine.ClusterOptionsPersistentVolumeConfigArgs{
					DefinedTags: pulumi.StringMap{
						"Operations.CostCenter": pulumi.String("42"),
					},
					FreeformTags: pulumi.StringMap{
						"Department": pulumi.String("Finance"),
					},
				},
				ServiceLbConfig: &containerengine.ClusterOptionsServiceLbConfigArgs{
					DefinedTags: pulumi.StringMap{
						"Operations.CostCenter": pulumi.String("42"),
					},
					FreeformTags: pulumi.StringMap{
						"Department": pulumi.String("Finance"),
					},
				},
				ServiceLbSubnetIds: pulumi.Any(clusterOptionsServiceLbSubnetIds),
			},
			Type: pulumi.Any(clusterType),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCluster = new Oci.ContainerEngine.Cluster("test_cluster", new()
    {
        CompartmentId = compartmentId,
        KubernetesVersion = clusterKubernetesVersion,
        Name = clusterName,
        VcnId = testVcn.Id,
        ClusterPodNetworkOptions = new[]
        {
            new Oci.ContainerEngine.Inputs.ClusterClusterPodNetworkOptionArgs
            {
                CniType = clusterClusterPodNetworkOptionsCniType,
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        EndpointConfig = new Oci.ContainerEngine.Inputs.ClusterEndpointConfigArgs
        {
            IsPublicIpEnabled = clusterEndpointConfigIsPublicIpEnabled,
            NsgIds = clusterEndpointConfigNsgIds,
            SubnetId = testSubnet.Id,
        },
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        ImagePolicyConfig = new Oci.ContainerEngine.Inputs.ClusterImagePolicyConfigArgs
        {
            IsPolicyEnabled = clusterImagePolicyConfigIsPolicyEnabled,
            KeyDetails = new[]
            {
                new Oci.ContainerEngine.Inputs.ClusterImagePolicyConfigKeyDetailArgs
                {
                    KmsKeyId = testKey.Id,
                },
            },
        },
        KmsKeyId = testKey.Id,
        Options = new Oci.ContainerEngine.Inputs.ClusterOptionsArgs
        {
            AddOns = new Oci.ContainerEngine.Inputs.ClusterOptionsAddOnsArgs
            {
                IsKubernetesDashboardEnabled = clusterOptionsAddOnsIsKubernetesDashboardEnabled,
                IsTillerEnabled = clusterOptionsAddOnsIsTillerEnabled,
            },
            AdmissionControllerOptions = new Oci.ContainerEngine.Inputs.ClusterOptionsAdmissionControllerOptionsArgs
            {
                IsPodSecurityPolicyEnabled = clusterOptionsAdmissionControllerOptionsIsPodSecurityPolicyEnabled,
            },
            IpFamilies = clusterOptionsIpFamilies,
            KubernetesNetworkConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsKubernetesNetworkConfigArgs
            {
                PodsCidr = clusterOptionsKubernetesNetworkConfigPodsCidr,
                ServicesCidr = clusterOptionsKubernetesNetworkConfigServicesCidr,
            },
            OpenIdConnectTokenAuthenticationConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs
            {
                IsOpenIdConnectAuthEnabled = clusterOptionsOpenIdConnectTokenAuthenticationConfigIsOpenIdConnectAuthEnabled,
                CaCertificate = clusterOptionsOpenIdConnectTokenAuthenticationConfigCaCertificate,
                ClientId = testClient.Id,
                ConfigurationFile = clusterOptionsOpenIdConnectTokenAuthenticationConfigConfigurationFile,
                GroupsClaim = clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsClaim,
                GroupsPrefix = clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsPrefix,
                IssuerUrl = clusterOptionsOpenIdConnectTokenAuthenticationConfigIssuerUrl,
                RequiredClaims = new[]
                {
                    new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs
                    {
                        Key = clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsKey,
                        Value = clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsValue,
                    },
                },
                SigningAlgorithms = clusterOptionsOpenIdConnectTokenAuthenticationConfigSigningAlgorithms,
                UsernameClaim = clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernameClaim,
                UsernamePrefix = clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernamePrefix,
            },
            OpenIdConnectDiscovery = new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectDiscoveryArgs
            {
                IsOpenIdConnectDiscoveryEnabled = clusterOptionsOpenIdConnectDiscoveryIsOpenIdConnectDiscoveryEnabled,
            },
            PersistentVolumeConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsPersistentVolumeConfigArgs
            {
                DefinedTags = 
                {
                    { "Operations.CostCenter", "42" },
                },
                FreeformTags = 
                {
                    { "Department", "Finance" },
                },
            },
            ServiceLbConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsServiceLbConfigArgs
            {
                DefinedTags = 
                {
                    { "Operations.CostCenter", "42" },
                },
                FreeformTags = 
                {
                    { "Department", "Finance" },
                },
            },
            ServiceLbSubnetIds = clusterOptionsServiceLbSubnetIds,
        },
        Type = clusterType,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ContainerEngine.Cluster;
import com.pulumi.oci.ContainerEngine.ClusterArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterClusterPodNetworkOptionArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterEndpointConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterImagePolicyConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsAddOnsArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsAdmissionControllerOptionsArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsKubernetesNetworkConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsOpenIdConnectDiscoveryArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsPersistentVolumeConfigArgs;
import com.pulumi.oci.ContainerEngine.inputs.ClusterOptionsServiceLbConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testCluster = new Cluster("testCluster", ClusterArgs.builder()
            .compartmentId(compartmentId)
            .kubernetesVersion(clusterKubernetesVersion)
            .name(clusterName)
            .vcnId(testVcn.id())
            .clusterPodNetworkOptions(ClusterClusterPodNetworkOptionArgs.builder()
                .cniType(clusterClusterPodNetworkOptionsCniType)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .endpointConfig(ClusterEndpointConfigArgs.builder()
                .isPublicIpEnabled(clusterEndpointConfigIsPublicIpEnabled)
                .nsgIds(clusterEndpointConfigNsgIds)
                .subnetId(testSubnet.id())
                .build())
            .freeformTags(Map.of("Department", "Finance"))
            .imagePolicyConfig(ClusterImagePolicyConfigArgs.builder()
                .isPolicyEnabled(clusterImagePolicyConfigIsPolicyEnabled)
                .keyDetails(ClusterImagePolicyConfigKeyDetailArgs.builder()
                    .kmsKeyId(testKey.id())
                    .build())
                .build())
            .kmsKeyId(testKey.id())
            .options(ClusterOptionsArgs.builder()
                .addOns(ClusterOptionsAddOnsArgs.builder()
                    .isKubernetesDashboardEnabled(clusterOptionsAddOnsIsKubernetesDashboardEnabled)
                    .isTillerEnabled(clusterOptionsAddOnsIsTillerEnabled)
                    .build())
                .admissionControllerOptions(ClusterOptionsAdmissionControllerOptionsArgs.builder()
                    .isPodSecurityPolicyEnabled(clusterOptionsAdmissionControllerOptionsIsPodSecurityPolicyEnabled)
                    .build())
                .ipFamilies(clusterOptionsIpFamilies)
                .kubernetesNetworkConfig(ClusterOptionsKubernetesNetworkConfigArgs.builder()
                    .podsCidr(clusterOptionsKubernetesNetworkConfigPodsCidr)
                    .servicesCidr(clusterOptionsKubernetesNetworkConfigServicesCidr)
                    .build())
                .openIdConnectTokenAuthenticationConfig(ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs.builder()
                    .isOpenIdConnectAuthEnabled(clusterOptionsOpenIdConnectTokenAuthenticationConfigIsOpenIdConnectAuthEnabled)
                    .caCertificate(clusterOptionsOpenIdConnectTokenAuthenticationConfigCaCertificate)
                    .clientId(testClient.id())
                    .configurationFile(clusterOptionsOpenIdConnectTokenAuthenticationConfigConfigurationFile)
                    .groupsClaim(clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsClaim)
                    .groupsPrefix(clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsPrefix)
                    .issuerUrl(clusterOptionsOpenIdConnectTokenAuthenticationConfigIssuerUrl)
                    .requiredClaims(ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs.builder()
                        .key(clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsKey)
                        .value(clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsValue)
                        .build())
                    .signingAlgorithms(clusterOptionsOpenIdConnectTokenAuthenticationConfigSigningAlgorithms)
                    .usernameClaim(clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernameClaim)
                    .usernamePrefix(clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernamePrefix)
                    .build())
                .openIdConnectDiscovery(ClusterOptionsOpenIdConnectDiscoveryArgs.builder()
                    .isOpenIdConnectDiscoveryEnabled(clusterOptionsOpenIdConnectDiscoveryIsOpenIdConnectDiscoveryEnabled)
                    .build())
                .persistentVolumeConfig(ClusterOptionsPersistentVolumeConfigArgs.builder()
                    .definedTags(Map.of("Operations.CostCenter", "42"))
                    .freeformTags(Map.of("Department", "Finance"))
                    .build())
                .serviceLbConfig(ClusterOptionsServiceLbConfigArgs.builder()
                    .definedTags(Map.of("Operations.CostCenter", "42"))
                    .freeformTags(Map.of("Department", "Finance"))
                    .build())
                .serviceLbSubnetIds(clusterOptionsServiceLbSubnetIds)
                .build())
            .type(clusterType)
            .build());

    }
}
Copy
resources:
  testCluster:
    type: oci:ContainerEngine:Cluster
    name: test_cluster
    properties:
      compartmentId: ${compartmentId}
      kubernetesVersion: ${clusterKubernetesVersion}
      name: ${clusterName}
      vcnId: ${testVcn.id}
      clusterPodNetworkOptions:
        - cniType: ${clusterClusterPodNetworkOptionsCniType}
      definedTags:
        Operations.CostCenter: '42'
      endpointConfig:
        isPublicIpEnabled: ${clusterEndpointConfigIsPublicIpEnabled}
        nsgIds: ${clusterEndpointConfigNsgIds}
        subnetId: ${testSubnet.id}
      freeformTags:
        Department: Finance
      imagePolicyConfig:
        isPolicyEnabled: ${clusterImagePolicyConfigIsPolicyEnabled}
        keyDetails:
          - kmsKeyId: ${testKey.id}
      kmsKeyId: ${testKey.id}
      options:
        addOns:
          isKubernetesDashboardEnabled: ${clusterOptionsAddOnsIsKubernetesDashboardEnabled}
          isTillerEnabled: ${clusterOptionsAddOnsIsTillerEnabled}
        admissionControllerOptions:
          isPodSecurityPolicyEnabled: ${clusterOptionsAdmissionControllerOptionsIsPodSecurityPolicyEnabled}
        ipFamilies: ${clusterOptionsIpFamilies}
        kubernetesNetworkConfig:
          podsCidr: ${clusterOptionsKubernetesNetworkConfigPodsCidr}
          servicesCidr: ${clusterOptionsKubernetesNetworkConfigServicesCidr}
        openIdConnectTokenAuthenticationConfig:
          isOpenIdConnectAuthEnabled: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigIsOpenIdConnectAuthEnabled}
          caCertificate: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigCaCertificate}
          clientId: ${testClient.id}
          configurationFile: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigConfigurationFile}
          groupsClaim: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsClaim}
          groupsPrefix: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigGroupsPrefix}
          issuerUrl: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigIssuerUrl}
          requiredClaims:
            - key: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsKey}
              value: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimsValue}
          signingAlgorithms: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigSigningAlgorithms}
          usernameClaim: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernameClaim}
          usernamePrefix: ${clusterOptionsOpenIdConnectTokenAuthenticationConfigUsernamePrefix}
        openIdConnectDiscovery:
          isOpenIdConnectDiscoveryEnabled: ${clusterOptionsOpenIdConnectDiscoveryIsOpenIdConnectDiscoveryEnabled}
        persistentVolumeConfig:
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
        serviceLbConfig:
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
        serviceLbSubnetIds: ${clusterOptionsServiceLbSubnetIds}
      type: ${clusterType}
Copy

Create Cluster Resource

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

Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            kubernetes_version: Optional[str] = None,
            vcn_id: Optional[str] = None,
            cluster_pod_network_options: Optional[Sequence[_containerengine.ClusterClusterPodNetworkOptionArgs]] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            endpoint_config: Optional[_containerengine.ClusterEndpointConfigArgs] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            image_policy_config: Optional[_containerengine.ClusterImagePolicyConfigArgs] = None,
            kms_key_id: Optional[str] = None,
            name: Optional[str] = None,
            options: Optional[_containerengine.ClusterOptionsArgs] = None,
            type: Optional[str] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: oci:ContainerEngine:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var clusterResource = new Oci.ContainerEngine.Cluster("clusterResource", new()
{
    CompartmentId = "string",
    KubernetesVersion = "string",
    VcnId = "string",
    ClusterPodNetworkOptions = new[]
    {
        new Oci.ContainerEngine.Inputs.ClusterClusterPodNetworkOptionArgs
        {
            CniType = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    EndpointConfig = new Oci.ContainerEngine.Inputs.ClusterEndpointConfigArgs
    {
        SubnetId = "string",
        IsPublicIpEnabled = false,
        NsgIds = new[]
        {
            "string",
        },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    ImagePolicyConfig = new Oci.ContainerEngine.Inputs.ClusterImagePolicyConfigArgs
    {
        IsPolicyEnabled = false,
        KeyDetails = new[]
        {
            new Oci.ContainerEngine.Inputs.ClusterImagePolicyConfigKeyDetailArgs
            {
                KmsKeyId = "string",
            },
        },
    },
    KmsKeyId = "string",
    Name = "string",
    Options = new Oci.ContainerEngine.Inputs.ClusterOptionsArgs
    {
        AddOns = new Oci.ContainerEngine.Inputs.ClusterOptionsAddOnsArgs
        {
            IsKubernetesDashboardEnabled = false,
            IsTillerEnabled = false,
        },
        AdmissionControllerOptions = new Oci.ContainerEngine.Inputs.ClusterOptionsAdmissionControllerOptionsArgs
        {
            IsPodSecurityPolicyEnabled = false,
        },
        IpFamilies = new[]
        {
            "string",
        },
        KubernetesNetworkConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsKubernetesNetworkConfigArgs
        {
            PodsCidr = "string",
            ServicesCidr = "string",
        },
        OpenIdConnectDiscovery = new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectDiscoveryArgs
        {
            IsOpenIdConnectDiscoveryEnabled = false,
        },
        OpenIdConnectTokenAuthenticationConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs
        {
            IsOpenIdConnectAuthEnabled = false,
            CaCertificate = "string",
            ClientId = "string",
            ConfigurationFile = "string",
            GroupsClaim = "string",
            GroupsPrefix = "string",
            IssuerUrl = "string",
            RequiredClaims = new[]
            {
                new Oci.ContainerEngine.Inputs.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
            SigningAlgorithms = new[]
            {
                "string",
            },
            UsernameClaim = "string",
            UsernamePrefix = "string",
        },
        PersistentVolumeConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsPersistentVolumeConfigArgs
        {
            DefinedTags = 
            {
                { "string", "string" },
            },
            FreeformTags = 
            {
                { "string", "string" },
            },
        },
        ServiceLbConfig = new Oci.ContainerEngine.Inputs.ClusterOptionsServiceLbConfigArgs
        {
            DefinedTags = 
            {
                { "string", "string" },
            },
            FreeformTags = 
            {
                { "string", "string" },
            },
        },
        ServiceLbSubnetIds = new[]
        {
            "string",
        },
    },
    Type = "string",
});
Copy
example, err := containerengine.NewCluster(ctx, "clusterResource", &containerengine.ClusterArgs{
	CompartmentId:     pulumi.String("string"),
	KubernetesVersion: pulumi.String("string"),
	VcnId:             pulumi.String("string"),
	ClusterPodNetworkOptions: containerengine.ClusterClusterPodNetworkOptionArray{
		&containerengine.ClusterClusterPodNetworkOptionArgs{
			CniType: pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EndpointConfig: &containerengine.ClusterEndpointConfigArgs{
		SubnetId:          pulumi.String("string"),
		IsPublicIpEnabled: pulumi.Bool(false),
		NsgIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ImagePolicyConfig: &containerengine.ClusterImagePolicyConfigArgs{
		IsPolicyEnabled: pulumi.Bool(false),
		KeyDetails: containerengine.ClusterImagePolicyConfigKeyDetailArray{
			&containerengine.ClusterImagePolicyConfigKeyDetailArgs{
				KmsKeyId: pulumi.String("string"),
			},
		},
	},
	KmsKeyId: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Options: &containerengine.ClusterOptionsArgs{
		AddOns: &containerengine.ClusterOptionsAddOnsArgs{
			IsKubernetesDashboardEnabled: pulumi.Bool(false),
			IsTillerEnabled:              pulumi.Bool(false),
		},
		AdmissionControllerOptions: &containerengine.ClusterOptionsAdmissionControllerOptionsArgs{
			IsPodSecurityPolicyEnabled: pulumi.Bool(false),
		},
		IpFamilies: pulumi.StringArray{
			pulumi.String("string"),
		},
		KubernetesNetworkConfig: &containerengine.ClusterOptionsKubernetesNetworkConfigArgs{
			PodsCidr:     pulumi.String("string"),
			ServicesCidr: pulumi.String("string"),
		},
		OpenIdConnectDiscovery: &containerengine.ClusterOptionsOpenIdConnectDiscoveryArgs{
			IsOpenIdConnectDiscoveryEnabled: pulumi.Bool(false),
		},
		OpenIdConnectTokenAuthenticationConfig: &containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs{
			IsOpenIdConnectAuthEnabled: pulumi.Bool(false),
			CaCertificate:              pulumi.String("string"),
			ClientId:                   pulumi.String("string"),
			ConfigurationFile:          pulumi.String("string"),
			GroupsClaim:                pulumi.String("string"),
			GroupsPrefix:               pulumi.String("string"),
			IssuerUrl:                  pulumi.String("string"),
			RequiredClaims: containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArray{
				&containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			SigningAlgorithms: pulumi.StringArray{
				pulumi.String("string"),
			},
			UsernameClaim:  pulumi.String("string"),
			UsernamePrefix: pulumi.String("string"),
		},
		PersistentVolumeConfig: &containerengine.ClusterOptionsPersistentVolumeConfigArgs{
			DefinedTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			FreeformTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		ServiceLbConfig: &containerengine.ClusterOptionsServiceLbConfigArgs{
			DefinedTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			FreeformTags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		ServiceLbSubnetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Type: pulumi.String("string"),
})
Copy
var clusterResource = new com.pulumi.oci.ContainerEngine.Cluster("clusterResource", com.pulumi.oci.ContainerEngine.ClusterArgs.builder()
    .compartmentId("string")
    .kubernetesVersion("string")
    .vcnId("string")
    .clusterPodNetworkOptions(ClusterClusterPodNetworkOptionArgs.builder()
        .cniType("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .endpointConfig(ClusterEndpointConfigArgs.builder()
        .subnetId("string")
        .isPublicIpEnabled(false)
        .nsgIds("string")
        .build())
    .freeformTags(Map.of("string", "string"))
    .imagePolicyConfig(ClusterImagePolicyConfigArgs.builder()
        .isPolicyEnabled(false)
        .keyDetails(ClusterImagePolicyConfigKeyDetailArgs.builder()
            .kmsKeyId("string")
            .build())
        .build())
    .kmsKeyId("string")
    .name("string")
    .options(ClusterOptionsArgs.builder()
        .addOns(ClusterOptionsAddOnsArgs.builder()
            .isKubernetesDashboardEnabled(false)
            .isTillerEnabled(false)
            .build())
        .admissionControllerOptions(ClusterOptionsAdmissionControllerOptionsArgs.builder()
            .isPodSecurityPolicyEnabled(false)
            .build())
        .ipFamilies("string")
        .kubernetesNetworkConfig(ClusterOptionsKubernetesNetworkConfigArgs.builder()
            .podsCidr("string")
            .servicesCidr("string")
            .build())
        .openIdConnectDiscovery(ClusterOptionsOpenIdConnectDiscoveryArgs.builder()
            .isOpenIdConnectDiscoveryEnabled(false)
            .build())
        .openIdConnectTokenAuthenticationConfig(ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs.builder()
            .isOpenIdConnectAuthEnabled(false)
            .caCertificate("string")
            .clientId("string")
            .configurationFile("string")
            .groupsClaim("string")
            .groupsPrefix("string")
            .issuerUrl("string")
            .requiredClaims(ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs.builder()
                .key("string")
                .value("string")
                .build())
            .signingAlgorithms("string")
            .usernameClaim("string")
            .usernamePrefix("string")
            .build())
        .persistentVolumeConfig(ClusterOptionsPersistentVolumeConfigArgs.builder()
            .definedTags(Map.of("string", "string"))
            .freeformTags(Map.of("string", "string"))
            .build())
        .serviceLbConfig(ClusterOptionsServiceLbConfigArgs.builder()
            .definedTags(Map.of("string", "string"))
            .freeformTags(Map.of("string", "string"))
            .build())
        .serviceLbSubnetIds("string")
        .build())
    .type("string")
    .build());
Copy
cluster_resource = oci.container_engine.Cluster("clusterResource",
    compartment_id="string",
    kubernetes_version="string",
    vcn_id="string",
    cluster_pod_network_options=[{
        "cni_type": "string",
    }],
    defined_tags={
        "string": "string",
    },
    endpoint_config={
        "subnet_id": "string",
        "is_public_ip_enabled": False,
        "nsg_ids": ["string"],
    },
    freeform_tags={
        "string": "string",
    },
    image_policy_config={
        "is_policy_enabled": False,
        "key_details": [{
            "kms_key_id": "string",
        }],
    },
    kms_key_id="string",
    name="string",
    options={
        "add_ons": {
            "is_kubernetes_dashboard_enabled": False,
            "is_tiller_enabled": False,
        },
        "admission_controller_options": {
            "is_pod_security_policy_enabled": False,
        },
        "ip_families": ["string"],
        "kubernetes_network_config": {
            "pods_cidr": "string",
            "services_cidr": "string",
        },
        "open_id_connect_discovery": {
            "is_open_id_connect_discovery_enabled": False,
        },
        "open_id_connect_token_authentication_config": {
            "is_open_id_connect_auth_enabled": False,
            "ca_certificate": "string",
            "client_id": "string",
            "configuration_file": "string",
            "groups_claim": "string",
            "groups_prefix": "string",
            "issuer_url": "string",
            "required_claims": [{
                "key": "string",
                "value": "string",
            }],
            "signing_algorithms": ["string"],
            "username_claim": "string",
            "username_prefix": "string",
        },
        "persistent_volume_config": {
            "defined_tags": {
                "string": "string",
            },
            "freeform_tags": {
                "string": "string",
            },
        },
        "service_lb_config": {
            "defined_tags": {
                "string": "string",
            },
            "freeform_tags": {
                "string": "string",
            },
        },
        "service_lb_subnet_ids": ["string"],
    },
    type="string")
Copy
const clusterResource = new oci.containerengine.Cluster("clusterResource", {
    compartmentId: "string",
    kubernetesVersion: "string",
    vcnId: "string",
    clusterPodNetworkOptions: [{
        cniType: "string",
    }],
    definedTags: {
        string: "string",
    },
    endpointConfig: {
        subnetId: "string",
        isPublicIpEnabled: false,
        nsgIds: ["string"],
    },
    freeformTags: {
        string: "string",
    },
    imagePolicyConfig: {
        isPolicyEnabled: false,
        keyDetails: [{
            kmsKeyId: "string",
        }],
    },
    kmsKeyId: "string",
    name: "string",
    options: {
        addOns: {
            isKubernetesDashboardEnabled: false,
            isTillerEnabled: false,
        },
        admissionControllerOptions: {
            isPodSecurityPolicyEnabled: false,
        },
        ipFamilies: ["string"],
        kubernetesNetworkConfig: {
            podsCidr: "string",
            servicesCidr: "string",
        },
        openIdConnectDiscovery: {
            isOpenIdConnectDiscoveryEnabled: false,
        },
        openIdConnectTokenAuthenticationConfig: {
            isOpenIdConnectAuthEnabled: false,
            caCertificate: "string",
            clientId: "string",
            configurationFile: "string",
            groupsClaim: "string",
            groupsPrefix: "string",
            issuerUrl: "string",
            requiredClaims: [{
                key: "string",
                value: "string",
            }],
            signingAlgorithms: ["string"],
            usernameClaim: "string",
            usernamePrefix: "string",
        },
        persistentVolumeConfig: {
            definedTags: {
                string: "string",
            },
            freeformTags: {
                string: "string",
            },
        },
        serviceLbConfig: {
            definedTags: {
                string: "string",
            },
            freeformTags: {
                string: "string",
            },
        },
        serviceLbSubnetIds: ["string"],
    },
    type: "string",
});
Copy
type: oci:ContainerEngine:Cluster
properties:
    clusterPodNetworkOptions:
        - cniType: string
    compartmentId: string
    definedTags:
        string: string
    endpointConfig:
        isPublicIpEnabled: false
        nsgIds:
            - string
        subnetId: string
    freeformTags:
        string: string
    imagePolicyConfig:
        isPolicyEnabled: false
        keyDetails:
            - kmsKeyId: string
    kmsKeyId: string
    kubernetesVersion: string
    name: string
    options:
        addOns:
            isKubernetesDashboardEnabled: false
            isTillerEnabled: false
        admissionControllerOptions:
            isPodSecurityPolicyEnabled: false
        ipFamilies:
            - string
        kubernetesNetworkConfig:
            podsCidr: string
            servicesCidr: string
        openIdConnectDiscovery:
            isOpenIdConnectDiscoveryEnabled: false
        openIdConnectTokenAuthenticationConfig:
            caCertificate: string
            clientId: string
            configurationFile: string
            groupsClaim: string
            groupsPrefix: string
            isOpenIdConnectAuthEnabled: false
            issuerUrl: string
            requiredClaims:
                - key: string
                  value: string
            signingAlgorithms:
                - string
            usernameClaim: string
            usernamePrefix: string
        persistentVolumeConfig:
            definedTags:
                string: string
            freeformTags:
                string: string
        serviceLbConfig:
            definedTags:
                string: string
            freeformTags:
                string: string
        serviceLbSubnetIds:
            - string
    type: string
    vcnId: string
Copy

Cluster Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Cluster resource accepts the following input properties:

CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment in which to create the cluster.
KubernetesVersion This property is required. string
(Updatable) The version of Kubernetes to install into the cluster masters.
VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ClusterPodNetworkOptions Changes to this property will trigger replacement. List<ClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
ImagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
Name string
(Updatable) The name of the cluster. Avoid entering confidential information.
Options ClusterOptions
(Updatable) Optional attributes for the cluster.
Type string
(Updatable) Type of cluster
CompartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment in which to create the cluster.
KubernetesVersion This property is required. string
(Updatable) The version of Kubernetes to install into the cluster masters.
VcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ClusterPodNetworkOptions Changes to this property will trigger replacement. []ClusterClusterPodNetworkOptionArgs
Available CNIs and network options for existing and new node pools of the cluster
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfig ClusterEndpointConfigArgs
The network configuration for access to the Cluster control plane.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
ImagePolicyConfig ClusterImagePolicyConfigArgs
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
Name string
(Updatable) The name of the cluster. Avoid entering confidential information.
Options ClusterOptionsArgs
(Updatable) Optional attributes for the cluster.
Type string
(Updatable) Type of cluster
compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment in which to create the cluster.
kubernetesVersion This property is required. String
(Updatable) The version of Kubernetes to install into the cluster masters.
vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterPodNetworkOptions Changes to this property will trigger replacement. List<ClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
name String
(Updatable) The name of the cluster. Avoid entering confidential information.
options ClusterOptions
(Updatable) Optional attributes for the cluster.
type String
(Updatable) Type of cluster
compartmentId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the compartment in which to create the cluster.
kubernetesVersion This property is required. string
(Updatable) The version of Kubernetes to install into the cluster masters.
vcnId
This property is required.
Changes to this property will trigger replacement.
string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterPodNetworkOptions Changes to this property will trigger replacement. ClusterClusterPodNetworkOption[]
Available CNIs and network options for existing and new node pools of the cluster
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
name string
(Updatable) The name of the cluster. Avoid entering confidential information.
options ClusterOptions
(Updatable) Optional attributes for the cluster.
type string
(Updatable) Type of cluster
compartment_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the compartment in which to create the cluster.
kubernetes_version This property is required. str
(Updatable) The version of Kubernetes to install into the cluster masters.
vcn_id
This property is required.
Changes to this property will trigger replacement.
str

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

cluster_pod_network_options Changes to this property will trigger replacement. Sequence[containerengine.ClusterClusterPodNetworkOptionArgs]
Available CNIs and network options for existing and new node pools of the cluster
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpoint_config containerengine.ClusterEndpointConfigArgs
The network configuration for access to the Cluster control plane.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
image_policy_config containerengine.ClusterImagePolicyConfigArgs
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kms_key_id Changes to this property will trigger replacement. str
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
name str
(Updatable) The name of the cluster. Avoid entering confidential information.
options containerengine.ClusterOptionsArgs
(Updatable) Optional attributes for the cluster.
type str
(Updatable) Type of cluster
compartmentId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the compartment in which to create the cluster.
kubernetesVersion This property is required. String
(Updatable) The version of Kubernetes to install into the cluster masters.
vcnId
This property is required.
Changes to this property will trigger replacement.
String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

clusterPodNetworkOptions Changes to this property will trigger replacement. List<Property Map>
Available CNIs and network options for existing and new node pools of the cluster
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig Property Map
The network configuration for access to the Cluster control plane.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig Property Map
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
name String
(Updatable) The name of the cluster. Avoid entering confidential information.
options Property Map
(Updatable) Optional attributes for the cluster.
type String
(Updatable) Type of cluster

Outputs

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

AvailableKubernetesUpgrades List<string>
Available Kubernetes versions to which the clusters masters may be upgraded.
Endpoints List<ClusterEndpoint>
Endpoints served up by the cluster masters.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Details about the state of the cluster masters.
Metadatas List<ClusterMetadata>
Metadata about the cluster.
OpenIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
State string
The state of the cluster masters.
AvailableKubernetesUpgrades []string
Available Kubernetes versions to which the clusters masters may be upgraded.
Endpoints []ClusterEndpoint
Endpoints served up by the cluster masters.
Id string
The provider-assigned unique ID for this managed resource.
LifecycleDetails string
Details about the state of the cluster masters.
Metadatas []ClusterMetadata
Metadata about the cluster.
OpenIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
State string
The state of the cluster masters.
availableKubernetesUpgrades List<String>
Available Kubernetes versions to which the clusters masters may be upgraded.
endpoints List<ClusterEndpoint>
Endpoints served up by the cluster masters.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Details about the state of the cluster masters.
metadatas List<ClusterMetadata>
Metadata about the cluster.
openIdConnectDiscoveryEndpoint String
The cluster-specific OpenID Connect Discovery endpoint
state String
The state of the cluster masters.
availableKubernetesUpgrades string[]
Available Kubernetes versions to which the clusters masters may be upgraded.
endpoints ClusterEndpoint[]
Endpoints served up by the cluster masters.
id string
The provider-assigned unique ID for this managed resource.
lifecycleDetails string
Details about the state of the cluster masters.
metadatas ClusterMetadata[]
Metadata about the cluster.
openIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
state string
The state of the cluster masters.
available_kubernetes_upgrades Sequence[str]
Available Kubernetes versions to which the clusters masters may be upgraded.
endpoints Sequence[containerengine.ClusterEndpoint]
Endpoints served up by the cluster masters.
id str
The provider-assigned unique ID for this managed resource.
lifecycle_details str
Details about the state of the cluster masters.
metadatas Sequence[containerengine.ClusterMetadata]
Metadata about the cluster.
open_id_connect_discovery_endpoint str
The cluster-specific OpenID Connect Discovery endpoint
state str
The state of the cluster masters.
availableKubernetesUpgrades List<String>
Available Kubernetes versions to which the clusters masters may be upgraded.
endpoints List<Property Map>
Endpoints served up by the cluster masters.
id String
The provider-assigned unique ID for this managed resource.
lifecycleDetails String
Details about the state of the cluster masters.
metadatas List<Property Map>
Metadata about the cluster.
openIdConnectDiscoveryEndpoint String
The cluster-specific OpenID Connect Discovery endpoint
state String
The state of the cluster masters.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        available_kubernetes_upgrades: Optional[Sequence[str]] = None,
        cluster_pod_network_options: Optional[Sequence[_containerengine.ClusterClusterPodNetworkOptionArgs]] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        endpoint_config: Optional[_containerengine.ClusterEndpointConfigArgs] = None,
        endpoints: Optional[Sequence[_containerengine.ClusterEndpointArgs]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        image_policy_config: Optional[_containerengine.ClusterImagePolicyConfigArgs] = None,
        kms_key_id: Optional[str] = None,
        kubernetes_version: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        metadatas: Optional[Sequence[_containerengine.ClusterMetadataArgs]] = None,
        name: Optional[str] = None,
        open_id_connect_discovery_endpoint: Optional[str] = None,
        options: Optional[_containerengine.ClusterOptionsArgs] = None,
        state: Optional[str] = None,
        type: Optional[str] = None,
        vcn_id: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
resources:  _:    type: oci:ContainerEngine:Cluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AvailableKubernetesUpgrades List<string>
Available Kubernetes versions to which the clusters masters may be upgraded.
ClusterPodNetworkOptions Changes to this property will trigger replacement. List<ClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
CompartmentId Changes to this property will trigger replacement. string
The OCID of the compartment in which to create the cluster.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
Endpoints List<ClusterEndpoint>
Endpoints served up by the cluster masters.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
ImagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
KubernetesVersion string
(Updatable) The version of Kubernetes to install into the cluster masters.
LifecycleDetails string
Details about the state of the cluster masters.
Metadatas List<ClusterMetadata>
Metadata about the cluster.
Name string
(Updatable) The name of the cluster. Avoid entering confidential information.
OpenIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
Options ClusterOptions
(Updatable) Optional attributes for the cluster.
State string
The state of the cluster masters.
Type string
(Updatable) Type of cluster
VcnId Changes to this property will trigger replacement. string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

AvailableKubernetesUpgrades []string
Available Kubernetes versions to which the clusters masters may be upgraded.
ClusterPodNetworkOptions Changes to this property will trigger replacement. []ClusterClusterPodNetworkOptionArgs
Available CNIs and network options for existing and new node pools of the cluster
CompartmentId Changes to this property will trigger replacement. string
The OCID of the compartment in which to create the cluster.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfig ClusterEndpointConfigArgs
The network configuration for access to the Cluster control plane.
Endpoints []ClusterEndpointArgs
Endpoints served up by the cluster masters.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
ImagePolicyConfig ClusterImagePolicyConfigArgs
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
KmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
KubernetesVersion string
(Updatable) The version of Kubernetes to install into the cluster masters.
LifecycleDetails string
Details about the state of the cluster masters.
Metadatas []ClusterMetadataArgs
Metadata about the cluster.
Name string
(Updatable) The name of the cluster. Avoid entering confidential information.
OpenIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
Options ClusterOptionsArgs
(Updatable) Optional attributes for the cluster.
State string
The state of the cluster masters.
Type string
(Updatable) Type of cluster
VcnId Changes to this property will trigger replacement. string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availableKubernetesUpgrades List<String>
Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions Changes to this property will trigger replacement. List<ClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
compartmentId Changes to this property will trigger replacement. String
The OCID of the compartment in which to create the cluster.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
endpoints List<ClusterEndpoint>
Endpoints served up by the cluster masters.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
kubernetesVersion String
(Updatable) The version of Kubernetes to install into the cluster masters.
lifecycleDetails String
Details about the state of the cluster masters.
metadatas List<ClusterMetadata>
Metadata about the cluster.
name String
(Updatable) The name of the cluster. Avoid entering confidential information.
openIdConnectDiscoveryEndpoint String
The cluster-specific OpenID Connect Discovery endpoint
options ClusterOptions
(Updatable) Optional attributes for the cluster.
state String
The state of the cluster masters.
type String
(Updatable) Type of cluster
vcnId Changes to this property will trigger replacement. String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availableKubernetesUpgrades string[]
Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions Changes to this property will trigger replacement. ClusterClusterPodNetworkOption[]
Available CNIs and network options for existing and new node pools of the cluster
compartmentId Changes to this property will trigger replacement. string
The OCID of the compartment in which to create the cluster.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig ClusterEndpointConfig
The network configuration for access to the Cluster control plane.
endpoints ClusterEndpoint[]
Endpoints served up by the cluster masters.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig ClusterImagePolicyConfig
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
kubernetesVersion string
(Updatable) The version of Kubernetes to install into the cluster masters.
lifecycleDetails string
Details about the state of the cluster masters.
metadatas ClusterMetadata[]
Metadata about the cluster.
name string
(Updatable) The name of the cluster. Avoid entering confidential information.
openIdConnectDiscoveryEndpoint string
The cluster-specific OpenID Connect Discovery endpoint
options ClusterOptions
(Updatable) Optional attributes for the cluster.
state string
The state of the cluster masters.
type string
(Updatable) Type of cluster
vcnId Changes to this property will trigger replacement. string

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

available_kubernetes_upgrades Sequence[str]
Available Kubernetes versions to which the clusters masters may be upgraded.
cluster_pod_network_options Changes to this property will trigger replacement. Sequence[containerengine.ClusterClusterPodNetworkOptionArgs]
Available CNIs and network options for existing and new node pools of the cluster
compartment_id Changes to this property will trigger replacement. str
The OCID of the compartment in which to create the cluster.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpoint_config containerengine.ClusterEndpointConfigArgs
The network configuration for access to the Cluster control plane.
endpoints Sequence[containerengine.ClusterEndpointArgs]
Endpoints served up by the cluster masters.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
image_policy_config containerengine.ClusterImagePolicyConfigArgs
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kms_key_id Changes to this property will trigger replacement. str
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
kubernetes_version str
(Updatable) The version of Kubernetes to install into the cluster masters.
lifecycle_details str
Details about the state of the cluster masters.
metadatas Sequence[containerengine.ClusterMetadataArgs]
Metadata about the cluster.
name str
(Updatable) The name of the cluster. Avoid entering confidential information.
open_id_connect_discovery_endpoint str
The cluster-specific OpenID Connect Discovery endpoint
options containerengine.ClusterOptionsArgs
(Updatable) Optional attributes for the cluster.
state str
The state of the cluster masters.
type str
(Updatable) Type of cluster
vcn_id Changes to this property will trigger replacement. str

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

availableKubernetesUpgrades List<String>
Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions Changes to this property will trigger replacement. List<Property Map>
Available CNIs and network options for existing and new node pools of the cluster
compartmentId Changes to this property will trigger replacement. String
The OCID of the compartment in which to create the cluster.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfig Property Map
The network configuration for access to the Cluster control plane.
endpoints List<Property Map>
Endpoints served up by the cluster masters.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
imagePolicyConfig Property Map
(Updatable) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.
kmsKeyId Changes to this property will trigger replacement. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, kubernetesVersion must be at least v1.13.0.
kubernetesVersion String
(Updatable) The version of Kubernetes to install into the cluster masters.
lifecycleDetails String
Details about the state of the cluster masters.
metadatas List<Property Map>
Metadata about the cluster.
name String
(Updatable) The name of the cluster. Avoid entering confidential information.
openIdConnectDiscoveryEndpoint String
The cluster-specific OpenID Connect Discovery endpoint
options Property Map
(Updatable) Optional attributes for the cluster.
state String
The state of the cluster masters.
type String
(Updatable) Type of cluster
vcnId Changes to this property will trigger replacement. String

The OCID of the virtual cloud network (VCN) in which to create the cluster.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Supporting Types

ClusterClusterPodNetworkOption
, ClusterClusterPodNetworkOptionArgs

CniType
This property is required.
Changes to this property will trigger replacement.
string
The CNI used by the node pools of this cluster
CniType
This property is required.
Changes to this property will trigger replacement.
string
The CNI used by the node pools of this cluster
cniType
This property is required.
Changes to this property will trigger replacement.
String
The CNI used by the node pools of this cluster
cniType
This property is required.
Changes to this property will trigger replacement.
string
The CNI used by the node pools of this cluster
cni_type
This property is required.
Changes to this property will trigger replacement.
str
The CNI used by the node pools of this cluster
cniType
This property is required.
Changes to this property will trigger replacement.
String
The CNI used by the node pools of this cluster

ClusterEndpoint
, ClusterEndpointArgs

Ipv6endpoint string
The IPv6 networking Kubernetes API server endpoint.
Kubernetes string
The non-native networking Kubernetes API server endpoint.
PrivateEndpoint string
The private native networking Kubernetes API server endpoint.
PublicEndpoint string
The public native networking Kubernetes API server endpoint, if one was requested.
VcnHostnameEndpoint string
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
Ipv6endpoint string
The IPv6 networking Kubernetes API server endpoint.
Kubernetes string
The non-native networking Kubernetes API server endpoint.
PrivateEndpoint string
The private native networking Kubernetes API server endpoint.
PublicEndpoint string
The public native networking Kubernetes API server endpoint, if one was requested.
VcnHostnameEndpoint string
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
ipv6endpoint String
The IPv6 networking Kubernetes API server endpoint.
kubernetes String
The non-native networking Kubernetes API server endpoint.
privateEndpoint String
The private native networking Kubernetes API server endpoint.
publicEndpoint String
The public native networking Kubernetes API server endpoint, if one was requested.
vcnHostnameEndpoint String
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
ipv6endpoint string
The IPv6 networking Kubernetes API server endpoint.
kubernetes string
The non-native networking Kubernetes API server endpoint.
privateEndpoint string
The private native networking Kubernetes API server endpoint.
publicEndpoint string
The public native networking Kubernetes API server endpoint, if one was requested.
vcnHostnameEndpoint string
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
ipv6endpoint str
The IPv6 networking Kubernetes API server endpoint.
kubernetes str
The non-native networking Kubernetes API server endpoint.
private_endpoint str
The private native networking Kubernetes API server endpoint.
public_endpoint str
The public native networking Kubernetes API server endpoint, if one was requested.
vcn_hostname_endpoint str
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
ipv6endpoint String
The IPv6 networking Kubernetes API server endpoint.
kubernetes String
The non-native networking Kubernetes API server endpoint.
privateEndpoint String
The private native networking Kubernetes API server endpoint.
publicEndpoint String
The public native networking Kubernetes API server endpoint, if one was requested.
vcnHostnameEndpoint String
The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

ClusterEndpointConfig
, ClusterEndpointConfigArgs

SubnetId This property is required. string
The OCID of the regional subnet in which to place the Cluster endpoint.
IsPublicIpEnabled bool
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
NsgIds List<string>
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
SubnetId This property is required. string
The OCID of the regional subnet in which to place the Cluster endpoint.
IsPublicIpEnabled bool
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
NsgIds []string
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
subnetId This property is required. String
The OCID of the regional subnet in which to place the Cluster endpoint.
isPublicIpEnabled Boolean
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
nsgIds List<String>
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
subnetId This property is required. string
The OCID of the regional subnet in which to place the Cluster endpoint.
isPublicIpEnabled boolean
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
nsgIds string[]
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
subnet_id This property is required. str
The OCID of the regional subnet in which to place the Cluster endpoint.
is_public_ip_enabled bool
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
nsg_ids Sequence[str]
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
subnetId This property is required. String
The OCID of the regional subnet in which to place the Cluster endpoint.
isPublicIpEnabled Boolean
Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.
nsgIds List<String>
A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.

ClusterImagePolicyConfig
, ClusterImagePolicyConfigArgs

IsPolicyEnabled bool
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
KeyDetails List<ClusterImagePolicyConfigKeyDetail>
(Updatable) A list of KMS key details.
IsPolicyEnabled bool
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
KeyDetails []ClusterImagePolicyConfigKeyDetail
(Updatable) A list of KMS key details.
isPolicyEnabled Boolean
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
keyDetails List<ClusterImagePolicyConfigKeyDetail>
(Updatable) A list of KMS key details.
isPolicyEnabled boolean
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
keyDetails ClusterImagePolicyConfigKeyDetail[]
(Updatable) A list of KMS key details.
is_policy_enabled bool
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
key_details Sequence[containerengine.ClusterImagePolicyConfigKeyDetail]
(Updatable) A list of KMS key details.
isPolicyEnabled Boolean
(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.
keyDetails List<Property Map>
(Updatable) A list of KMS key details.

ClusterImagePolicyConfigKeyDetail
, ClusterImagePolicyConfigKeyDetailArgs

KmsKeyId string
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
KmsKeyId string
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
kmsKeyId String
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
kmsKeyId string
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
kms_key_id str
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.
kmsKeyId String
(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.

ClusterMetadata
, ClusterMetadataArgs

CreatedByUserId string
The user who created the cluster.
CreatedByWorkRequestId string
The OCID of the work request which created the cluster.
DeletedByUserId string
The user who deleted the cluster.
DeletedByWorkRequestId string
The OCID of the work request which deleted the cluster.
TimeCreated string
The time the cluster was created.
TimeCredentialExpiration string
The time until which the cluster credential is valid.
TimeDeleted string
The time the cluster was deleted.
TimeUpdated string
The time the cluster was updated.
UpdatedByUserId string
The user who updated the cluster.
UpdatedByWorkRequestId string
The OCID of the work request which updated the cluster.
CreatedByUserId string
The user who created the cluster.
CreatedByWorkRequestId string
The OCID of the work request which created the cluster.
DeletedByUserId string
The user who deleted the cluster.
DeletedByWorkRequestId string
The OCID of the work request which deleted the cluster.
TimeCreated string
The time the cluster was created.
TimeCredentialExpiration string
The time until which the cluster credential is valid.
TimeDeleted string
The time the cluster was deleted.
TimeUpdated string
The time the cluster was updated.
UpdatedByUserId string
The user who updated the cluster.
UpdatedByWorkRequestId string
The OCID of the work request which updated the cluster.
createdByUserId String
The user who created the cluster.
createdByWorkRequestId String
The OCID of the work request which created the cluster.
deletedByUserId String
The user who deleted the cluster.
deletedByWorkRequestId String
The OCID of the work request which deleted the cluster.
timeCreated String
The time the cluster was created.
timeCredentialExpiration String
The time until which the cluster credential is valid.
timeDeleted String
The time the cluster was deleted.
timeUpdated String
The time the cluster was updated.
updatedByUserId String
The user who updated the cluster.
updatedByWorkRequestId String
The OCID of the work request which updated the cluster.
createdByUserId string
The user who created the cluster.
createdByWorkRequestId string
The OCID of the work request which created the cluster.
deletedByUserId string
The user who deleted the cluster.
deletedByWorkRequestId string
The OCID of the work request which deleted the cluster.
timeCreated string
The time the cluster was created.
timeCredentialExpiration string
The time until which the cluster credential is valid.
timeDeleted string
The time the cluster was deleted.
timeUpdated string
The time the cluster was updated.
updatedByUserId string
The user who updated the cluster.
updatedByWorkRequestId string
The OCID of the work request which updated the cluster.
created_by_user_id str
The user who created the cluster.
created_by_work_request_id str
The OCID of the work request which created the cluster.
deleted_by_user_id str
The user who deleted the cluster.
deleted_by_work_request_id str
The OCID of the work request which deleted the cluster.
time_created str
The time the cluster was created.
time_credential_expiration str
The time until which the cluster credential is valid.
time_deleted str
The time the cluster was deleted.
time_updated str
The time the cluster was updated.
updated_by_user_id str
The user who updated the cluster.
updated_by_work_request_id str
The OCID of the work request which updated the cluster.
createdByUserId String
The user who created the cluster.
createdByWorkRequestId String
The OCID of the work request which created the cluster.
deletedByUserId String
The user who deleted the cluster.
deletedByWorkRequestId String
The OCID of the work request which deleted the cluster.
timeCreated String
The time the cluster was created.
timeCredentialExpiration String
The time until which the cluster credential is valid.
timeDeleted String
The time the cluster was deleted.
timeUpdated String
The time the cluster was updated.
updatedByUserId String
The user who updated the cluster.
updatedByWorkRequestId String
The OCID of the work request which updated the cluster.

ClusterOptions
, ClusterOptionsArgs

AddOns Changes to this property will trigger replacement. ClusterOptionsAddOns
Configurable cluster add-ons
AdmissionControllerOptions ClusterOptionsAdmissionControllerOptions
(Updatable) Configurable cluster admission controllers
IpFamilies Changes to this property will trigger replacement. List<string>
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
KubernetesNetworkConfig Changes to this property will trigger replacement. ClusterOptionsKubernetesNetworkConfig
Network configuration for Kubernetes.
OpenIdConnectDiscovery ClusterOptionsOpenIdConnectDiscovery
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfig ClusterOptionsOpenIdConnectTokenAuthenticationConfig
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfig ClusterOptionsPersistentVolumeConfig
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfig ClusterOptionsServiceLbConfig
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds Changes to this property will trigger replacement. List<string>
The OCIDs of the subnets used for Kubernetes services load balancers.
AddOns Changes to this property will trigger replacement. ClusterOptionsAddOns
Configurable cluster add-ons
AdmissionControllerOptions ClusterOptionsAdmissionControllerOptions
(Updatable) Configurable cluster admission controllers
IpFamilies Changes to this property will trigger replacement. []string
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
KubernetesNetworkConfig Changes to this property will trigger replacement. ClusterOptionsKubernetesNetworkConfig
Network configuration for Kubernetes.
OpenIdConnectDiscovery ClusterOptionsOpenIdConnectDiscovery
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfig ClusterOptionsOpenIdConnectTokenAuthenticationConfig
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfig ClusterOptionsPersistentVolumeConfig
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfig ClusterOptionsServiceLbConfig
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds Changes to this property will trigger replacement. []string
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns Changes to this property will trigger replacement. ClusterOptionsAddOns
Configurable cluster add-ons
admissionControllerOptions ClusterOptionsAdmissionControllerOptions
(Updatable) Configurable cluster admission controllers
ipFamilies Changes to this property will trigger replacement. List<String>
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
kubernetesNetworkConfig Changes to this property will trigger replacement. ClusterOptionsKubernetesNetworkConfig
Network configuration for Kubernetes.
openIdConnectDiscovery ClusterOptionsOpenIdConnectDiscovery
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfig ClusterOptionsOpenIdConnectTokenAuthenticationConfig
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfig ClusterOptionsPersistentVolumeConfig
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfig ClusterOptionsServiceLbConfig
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds Changes to this property will trigger replacement. List<String>
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns Changes to this property will trigger replacement. ClusterOptionsAddOns
Configurable cluster add-ons
admissionControllerOptions ClusterOptionsAdmissionControllerOptions
(Updatable) Configurable cluster admission controllers
ipFamilies Changes to this property will trigger replacement. string[]
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
kubernetesNetworkConfig Changes to this property will trigger replacement. ClusterOptionsKubernetesNetworkConfig
Network configuration for Kubernetes.
openIdConnectDiscovery ClusterOptionsOpenIdConnectDiscovery
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfig ClusterOptionsOpenIdConnectTokenAuthenticationConfig
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfig ClusterOptionsPersistentVolumeConfig
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfig ClusterOptionsServiceLbConfig
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds Changes to this property will trigger replacement. string[]
The OCIDs of the subnets used for Kubernetes services load balancers.
add_ons Changes to this property will trigger replacement. containerengine.ClusterOptionsAddOns
Configurable cluster add-ons
admission_controller_options containerengine.ClusterOptionsAdmissionControllerOptions
(Updatable) Configurable cluster admission controllers
ip_families Changes to this property will trigger replacement. Sequence[str]
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
kubernetes_network_config Changes to this property will trigger replacement. containerengine.ClusterOptionsKubernetesNetworkConfig
Network configuration for Kubernetes.
open_id_connect_discovery containerengine.ClusterOptionsOpenIdConnectDiscovery
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
open_id_connect_token_authentication_config containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfig
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistent_volume_config containerengine.ClusterOptionsPersistentVolumeConfig
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
service_lb_config containerengine.ClusterOptionsServiceLbConfig
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
service_lb_subnet_ids Changes to this property will trigger replacement. Sequence[str]
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns Changes to this property will trigger replacement. Property Map
Configurable cluster add-ons
admissionControllerOptions Property Map
(Updatable) Configurable cluster admission controllers
ipFamilies Changes to this property will trigger replacement. List<String>
IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).
kubernetesNetworkConfig Changes to this property will trigger replacement. Property Map
Network configuration for Kubernetes.
openIdConnectDiscovery Property Map
(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfig Property Map
(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfig Property Map
(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfig Property Map
(Updatable) Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds Changes to this property will trigger replacement. List<String>
The OCIDs of the subnets used for Kubernetes services load balancers.

ClusterOptionsAddOns
, ClusterOptionsAddOnsArgs

IsKubernetesDashboardEnabled Changes to this property will trigger replacement. bool
Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled Changes to this property will trigger replacement. bool
Whether or not to enable the Tiller add-on.
IsKubernetesDashboardEnabled Changes to this property will trigger replacement. bool
Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled Changes to this property will trigger replacement. bool
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled Changes to this property will trigger replacement. Boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled Changes to this property will trigger replacement. Boolean
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled Changes to this property will trigger replacement. boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled Changes to this property will trigger replacement. boolean
Whether or not to enable the Tiller add-on.
is_kubernetes_dashboard_enabled Changes to this property will trigger replacement. bool
Whether or not to enable the Kubernetes Dashboard add-on.
is_tiller_enabled Changes to this property will trigger replacement. bool
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled Changes to this property will trigger replacement. Boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled Changes to this property will trigger replacement. Boolean
Whether or not to enable the Tiller add-on.

ClusterOptionsAdmissionControllerOptions
, ClusterOptionsAdmissionControllerOptionsArgs

IsPodSecurityPolicyEnabled bool
(Updatable) Whether or not to enable the Pod Security Policy admission controller.
IsPodSecurityPolicyEnabled bool
(Updatable) Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled Boolean
(Updatable) Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled boolean
(Updatable) Whether or not to enable the Pod Security Policy admission controller.
is_pod_security_policy_enabled bool
(Updatable) Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled Boolean
(Updatable) Whether or not to enable the Pod Security Policy admission controller.

ClusterOptionsKubernetesNetworkConfig
, ClusterOptionsKubernetesNetworkConfigArgs

PodsCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
ServicesCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.
PodsCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
ServicesCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.
podsCidr Changes to this property will trigger replacement. String
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
servicesCidr Changes to this property will trigger replacement. String
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.
podsCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
servicesCidr Changes to this property will trigger replacement. string
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.
pods_cidr Changes to this property will trigger replacement. str
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
services_cidr Changes to this property will trigger replacement. str
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.
podsCidr Changes to this property will trigger replacement. String
The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.
servicesCidr Changes to this property will trigger replacement. String
The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.

ClusterOptionsOpenIdConnectDiscovery
, ClusterOptionsOpenIdConnectDiscoveryArgs

IsOpenIdConnectDiscoveryEnabled bool
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
IsOpenIdConnectDiscoveryEnabled bool
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
isOpenIdConnectDiscoveryEnabled Boolean
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
isOpenIdConnectDiscoveryEnabled boolean
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
is_open_id_connect_discovery_enabled bool
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.
isOpenIdConnectDiscoveryEnabled Boolean
(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.

ClusterOptionsOpenIdConnectTokenAuthenticationConfig
, ClusterOptionsOpenIdConnectTokenAuthenticationConfigArgs

IsOpenIdConnectAuthEnabled This property is required. bool
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
CaCertificate string
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId string
(Updatable) A client id that all tokens must be issued for.
ConfigurationFile string
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim string
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix string
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IssuerUrl string
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
RequiredClaims List<ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim>
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
SigningAlgorithms List<string>
(Updatable) The signing algorithms accepted. Default is ["RS256"].
UsernameClaim string
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
UsernamePrefix string
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
IsOpenIdConnectAuthEnabled This property is required. bool
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
CaCertificate string
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId string
(Updatable) A client id that all tokens must be issued for.
ConfigurationFile string
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim string
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix string
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IssuerUrl string
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
RequiredClaims []ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
SigningAlgorithms []string
(Updatable) The signing algorithms accepted. Default is ["RS256"].
UsernameClaim string
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
UsernamePrefix string
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
isOpenIdConnectAuthEnabled This property is required. Boolean
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
caCertificate String
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId String
(Updatable) A client id that all tokens must be issued for.
configurationFile String
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim String
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix String
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
issuerUrl String
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
requiredClaims List<ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim>
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
signingAlgorithms List<String>
(Updatable) The signing algorithms accepted. Default is ["RS256"].
usernameClaim String
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
usernamePrefix String
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
isOpenIdConnectAuthEnabled This property is required. boolean
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
caCertificate string
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId string
(Updatable) A client id that all tokens must be issued for.
configurationFile string
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim string
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix string
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
issuerUrl string
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
requiredClaims ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim[]
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
signingAlgorithms string[]
(Updatable) The signing algorithms accepted. Default is ["RS256"].
usernameClaim string
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
usernamePrefix string
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
is_open_id_connect_auth_enabled This property is required. bool
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
ca_certificate str
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
client_id str
(Updatable) A client id that all tokens must be issued for.
configuration_file str
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groups_claim str
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groups_prefix str
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
issuer_url str
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
required_claims Sequence[containerengine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim]
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
signing_algorithms Sequence[str]
(Updatable) The signing algorithms accepted. Default is ["RS256"].
username_claim str
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
username_prefix str
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.
isOpenIdConnectAuthEnabled This property is required. Boolean
(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.
caCertificate String
(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId String
(Updatable) A client id that all tokens must be issued for.
configurationFile String
(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim String
(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix String
(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
issuerUrl String
(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.
requiredClaims List<Property Map>
(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
signingAlgorithms List<String>
(Updatable) The signing algorithms accepted. Default is ["RS256"].
usernameClaim String
(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.
usernamePrefix String
(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.

ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim
, ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaimArgs

Key string
(Updatable) The key of the pair.
Value string
(Updatable) The value of the pair.
Key string
(Updatable) The key of the pair.
Value string
(Updatable) The value of the pair.
key String
(Updatable) The key of the pair.
value String
(Updatable) The value of the pair.
key string
(Updatable) The key of the pair.
value string
(Updatable) The value of the pair.
key str
(Updatable) The key of the pair.
value str
(Updatable) The value of the pair.
key String
(Updatable) The key of the pair.
value String
(Updatable) The value of the pair.

ClusterOptionsPersistentVolumeConfig
, ClusterOptionsPersistentVolumeConfigArgs

DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

ClusterOptionsServiceLbConfig
, ClusterOptionsServiceLbConfigArgs

DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Import

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

$ pulumi import oci:ContainerEngine/cluster:Cluster test_cluster "id"
Copy

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci