Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.ContainerEngine.getClusters

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testClusters = oci.ContainerEngine.getClusters({
    compartmentId: compartmentId,
    name: clusterName,
    states: clusterState,
});

import pulumi
import pulumi_oci as oci

test_clusters = oci.ContainerEngine.get_clusters(compartment_id=compartment_id,
    name=cluster_name,
    states=cluster_state)

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.GetClusters(ctx, &containerengine.GetClustersArgs{
			CompartmentId: compartmentId,
			Name:          pulumi.StringRef(clusterName),
			States:        clusterState,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testClusters = Oci.ContainerEngine.GetClusters.Invoke(new()
    {
        CompartmentId = compartmentId,
        Name = clusterName,
        States = clusterState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ContainerEngine.ContainerEngineFunctions;
import com.pulumi.oci.ContainerEngine.inputs.GetClustersArgs;
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) {
        final var testClusters = ContainerEngineFunctions.getClusters(GetClustersArgs.builder()
            .compartmentId(compartmentId)
            .name(clusterName)
            .states(clusterState)
            .build());

    }
}

variables:
  testClusters:
    fn::invoke:
      function: oci:ContainerEngine:getClusters
      arguments:
        compartmentId: ${compartmentId}
        name: ${clusterName}
        states: ${clusterState}

Using getClusters

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>

def get_clusters(compartment_id: Optional[str] = None,
                 filters: Optional[Sequence[_containerengine.GetClustersFilter]] = None,
                 name: Optional[str] = None,
                 states: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_containerengine.GetClustersFilterArgs]]]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 states: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]

func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

> Note: This function is named GetClusters in the Go SDK.

public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
public static Output<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ContainerEngine/getClusters:getClusters
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
Filters List<GetClustersFilter>
Name string: The name to filter on.
States List<string>: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

CompartmentId string: The OCID of the compartment.
Filters []GetClustersFilter
Name string: The name to filter on.
States []string: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

compartmentId String: The OCID of the compartment.
filters List<GetClustersFilter>
name String: The name to filter on.
states List<String>: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

compartmentId string: The OCID of the compartment.
filters GetClustersFilter[]
name string: The name to filter on.
states string[]: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

compartment_id str: The OCID of the compartment.
filters Sequence[containerengine.GetClustersFilter]
name str: The name to filter on.
states Sequence[str]: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

compartmentId String: The OCID of the compartment.
filters List<Property Map>
name String: The name to filter on.
states List<String>: A cluster lifecycle state to filter on. Can have multiple parameters of this name.

getClusters Result

The following output properties are available:

Clusters List<GetClustersCluster>: The list of clusters.
CompartmentId string: The OCID of the compartment in which the cluster exists.
Id string: The provider-assigned unique ID for this managed resource.
Filters List<GetClustersFilter>
Name string: The name of the cluster.
States List<string>: The state of the cluster masters.

Clusters []GetClustersCluster: The list of clusters.
CompartmentId string: The OCID of the compartment in which the cluster exists.
Id string: The provider-assigned unique ID for this managed resource.
Filters []GetClustersFilter
Name string: The name of the cluster.
States []string: The state of the cluster masters.

clusters List<GetClustersCluster>: The list of clusters.
compartmentId String: The OCID of the compartment in which the cluster exists.
id String: The provider-assigned unique ID for this managed resource.
filters List<GetClustersFilter>
name String: The name of the cluster.
states List<String>: The state of the cluster masters.

clusters GetClustersCluster[]: The list of clusters.
compartmentId string: The OCID of the compartment in which the cluster exists.
id string: The provider-assigned unique ID for this managed resource.
filters GetClustersFilter[]
name string: The name of the cluster.
states string[]: The state of the cluster masters.

clusters Sequence[containerengine.GetClustersCluster]: The list of clusters.
compartment_id str: The OCID of the compartment in which the cluster exists.
id str: The provider-assigned unique ID for this managed resource.
filters Sequence[containerengine.GetClustersFilter]
name str: The name of the cluster.
states Sequence[str]: The state of the cluster masters.

clusters List<Property Map>: The list of clusters.
compartmentId String: The OCID of the compartment in which the cluster exists.
id String: The provider-assigned unique ID for this managed resource.
filters List<Property Map>
name String: The name of the cluster.
states List<String>: The state of the cluster masters.

Supporting Types

GetClustersCluster

AvailableKubernetesUpgrades List<string>: Available Kubernetes versions to which the clusters masters may be upgraded.
ClusterPodNetworkOptions List<GetClustersClusterClusterPodNetworkOption>: Available CNIs and network options for existing and new node pools of the cluster
CompartmentId string: The OCID of the compartment.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfigs List<GetClustersClusterEndpointConfig>: The network configuration for access to the Cluster control plane.
Endpoints List<GetClustersClusterEndpoint>: Endpoints served up by the cluster masters.
FreeformTags Dictionary<string, string>: 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"}
Id string: The OCID of the cluster.
ImagePolicyConfigs List<GetClustersClusterImagePolicyConfig>: The image verification policy for signature validation.
KmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
KubernetesVersion string: The version of Kubernetes running on the cluster masters.
LifecycleDetails string: Details about the state of the cluster masters.
Metadatas List<GetClustersClusterMetadata>: Metadata about the cluster.
Name string: The name to filter on.
OpenIdConnectDiscoveryEndpoint string: The cluster-specific OpenID Connect Discovery endpoint
Options List<GetClustersClusterOption>: Optional attributes for the cluster.
State string: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
Type string: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
VcnId string: The OCID of the virtual cloud network (VCN) in which the cluster exists.

AvailableKubernetesUpgrades []string: Available Kubernetes versions to which the clusters masters may be upgraded.
ClusterPodNetworkOptions []GetClustersClusterClusterPodNetworkOption: Available CNIs and network options for existing and new node pools of the cluster
CompartmentId string: The OCID of the compartment.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
EndpointConfigs []GetClustersClusterEndpointConfig: The network configuration for access to the Cluster control plane.
Endpoints []GetClustersClusterEndpoint: Endpoints served up by the cluster masters.
FreeformTags map[string]string: 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"}
Id string: The OCID of the cluster.
ImagePolicyConfigs []GetClustersClusterImagePolicyConfig: The image verification policy for signature validation.
KmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
KubernetesVersion string: The version of Kubernetes running on the cluster masters.
LifecycleDetails string: Details about the state of the cluster masters.
Metadatas []GetClustersClusterMetadata: Metadata about the cluster.
Name string: The name to filter on.
OpenIdConnectDiscoveryEndpoint string: The cluster-specific OpenID Connect Discovery endpoint
Options []GetClustersClusterOption: Optional attributes for the cluster.
State string: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
Type string: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
VcnId string: The OCID of the virtual cloud network (VCN) in which the cluster exists.

availableKubernetesUpgrades List<String>: Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions List<GetClustersClusterClusterPodNetworkOption>: Available CNIs and network options for existing and new node pools of the cluster
compartmentId String: The OCID of the compartment.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfigs List<GetClustersClusterEndpointConfig>: The network configuration for access to the Cluster control plane.
endpoints List<GetClustersClusterEndpoint>: Endpoints served up by the cluster masters.
freeformTags Map<String,String>: 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"}
id String: The OCID of the cluster.
imagePolicyConfigs List<GetClustersClusterImagePolicyConfig>: The image verification policy for signature validation.
kmsKeyId String: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kubernetesVersion String: The version of Kubernetes running on the cluster masters.
lifecycleDetails String: Details about the state of the cluster masters.
metadatas List<GetClustersClusterMetadata>: Metadata about the cluster.
name String: The name to filter on.
openIdConnectDiscoveryEndpoint String: The cluster-specific OpenID Connect Discovery endpoint
options List<GetClustersClusterOption>: Optional attributes for the cluster.
state String: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
type String: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
vcnId String: The OCID of the virtual cloud network (VCN) in which the cluster exists.

availableKubernetesUpgrades string[]: Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions GetClustersClusterClusterPodNetworkOption[]: Available CNIs and network options for existing and new node pools of the cluster
compartmentId string: The OCID of the compartment.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfigs GetClustersClusterEndpointConfig[]: The network configuration for access to the Cluster control plane.
endpoints GetClustersClusterEndpoint[]: Endpoints served up by the cluster masters.
freeformTags {[key: string]: string}: 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"}
id string: The OCID of the cluster.
imagePolicyConfigs GetClustersClusterImagePolicyConfig[]: The image verification policy for signature validation.
kmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kubernetesVersion string: The version of Kubernetes running on the cluster masters.
lifecycleDetails string: Details about the state of the cluster masters.
metadatas GetClustersClusterMetadata[]: Metadata about the cluster.
name string: The name to filter on.
openIdConnectDiscoveryEndpoint string: The cluster-specific OpenID Connect Discovery endpoint
options GetClustersClusterOption[]: Optional attributes for the cluster.
state string: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
type string: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
vcnId string: The OCID of the virtual cloud network (VCN) in which the cluster exists.

available_kubernetes_upgrades Sequence[str]: Available Kubernetes versions to which the clusters masters may be upgraded.
cluster_pod_network_options Sequence[containerengine.GetClustersClusterClusterPodNetworkOption]: Available CNIs and network options for existing and new node pools of the cluster
compartment_id str: The OCID of the compartment.
defined_tags Mapping[str, str]: 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_configs Sequence[containerengine.GetClustersClusterEndpointConfig]: The network configuration for access to the Cluster control plane.
endpoints Sequence[containerengine.GetClustersClusterEndpoint]: Endpoints served up by the cluster masters.
freeform_tags Mapping[str, str]: 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"}
id str: The OCID of the cluster.
image_policy_configs Sequence[containerengine.GetClustersClusterImagePolicyConfig]: The image verification policy for signature validation.
kms_key_id str: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kubernetes_version str: The version of Kubernetes running on the cluster masters.
lifecycle_details str: Details about the state of the cluster masters.
metadatas Sequence[containerengine.GetClustersClusterMetadata]: Metadata about the cluster.
name str: The name to filter on.
open_id_connect_discovery_endpoint str: The cluster-specific OpenID Connect Discovery endpoint
options Sequence[containerengine.GetClustersClusterOption]: Optional attributes for the cluster.
state str: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
type str: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
vcn_id str: The OCID of the virtual cloud network (VCN) in which the cluster exists.

availableKubernetesUpgrades List<String>: Available Kubernetes versions to which the clusters masters may be upgraded.
clusterPodNetworkOptions List<Property Map>: Available CNIs and network options for existing and new node pools of the cluster
compartmentId String: The OCID of the compartment.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
endpointConfigs List<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>: 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"}
id String: The OCID of the cluster.
imagePolicyConfigs List<Property Map>: The image verification policy for signature validation.
kmsKeyId String: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kubernetesVersion String: The version of Kubernetes running on the cluster masters.
lifecycleDetails String: Details about the state of the cluster masters.
metadatas List<Property Map>: Metadata about the cluster.
name String: The name to filter on.
openIdConnectDiscoveryEndpoint String: The cluster-specific OpenID Connect Discovery endpoint
options List<Property Map>: Optional attributes for the cluster.
state String: A cluster lifecycle state to filter on. Can have multiple parameters of this name.
type String: Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types
vcnId String: The OCID of the virtual cloud network (VCN) in which the cluster exists.

GetClustersClusterClusterPodNetworkOption

CniType string: The CNI used by the node pools of this cluster

CniType string: The CNI used by the node pools of this cluster

cniType String: The CNI used by the node pools of this cluster

cniType string: The CNI used by the node pools of this cluster

cni_type str: The CNI used by the node pools of this cluster

cniType String: The CNI used by the node pools of this cluster

GetClustersClusterEndpoint

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'

GetClustersClusterEndpointConfig

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 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 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 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.
subnetId string: 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.
subnet_id str: 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 String: The OCID of the regional subnet in which to place the Cluster endpoint.

GetClustersClusterImagePolicyConfig

IsPolicyEnabled bool: 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<GetClustersClusterImagePolicyConfigKeyDetail>: A list of KMS key details.

IsPolicyEnabled bool: 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 []GetClustersClusterImagePolicyConfigKeyDetail: A list of KMS key details.

isPolicyEnabled Boolean: 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<GetClustersClusterImagePolicyConfigKeyDetail>: A list of KMS key details.

isPolicyEnabled boolean: 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 GetClustersClusterImagePolicyConfigKeyDetail[]: A list of KMS key details.

is_policy_enabled bool: 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.GetClustersClusterImagePolicyConfigKeyDetail]: A list of KMS key details.

isPolicyEnabled Boolean: 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>: A list of KMS key details.

GetClustersClusterImagePolicyConfigKeyDetail

KmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

KmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

kmsKeyId String: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

kmsKeyId string: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

kms_key_id str: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

kmsKeyId String: The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

GetClustersClusterMetadata

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.

GetClustersClusterOption

AddOns List<GetClustersClusterOptionAddOn>: Configurable cluster add-ons
AdmissionControllerOptions List<GetClustersClusterOptionAdmissionControllerOption>: Configurable cluster admission controllers
IpFamilies 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).
KubernetesNetworkConfigs List<GetClustersClusterOptionKubernetesNetworkConfig>: Network configuration for Kubernetes.
OpenIdConnectDiscoveries List<GetClustersClusterOptionOpenIdConnectDiscovery>: The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfigs List<GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig>: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfigs List<GetClustersClusterOptionPersistentVolumeConfig>: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfigs List<GetClustersClusterOptionServiceLbConfig>: Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds List<string>: The OCIDs of the subnets used for Kubernetes services load balancers.

AddOns []GetClustersClusterOptionAddOn: Configurable cluster add-ons
AdmissionControllerOptions []GetClustersClusterOptionAdmissionControllerOption: Configurable cluster admission controllers
IpFamilies []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).
KubernetesNetworkConfigs []GetClustersClusterOptionKubernetesNetworkConfig: Network configuration for Kubernetes.
OpenIdConnectDiscoveries []GetClustersClusterOptionOpenIdConnectDiscovery: The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfigs []GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfigs []GetClustersClusterOptionPersistentVolumeConfig: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfigs []GetClustersClusterOptionServiceLbConfig: Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds []string: The OCIDs of the subnets used for Kubernetes services load balancers.

addOns List<GetClustersClusterOptionAddOn>: Configurable cluster add-ons
admissionControllerOptions List<GetClustersClusterOptionAdmissionControllerOption>: Configurable cluster admission controllers
ipFamilies 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).
kubernetesNetworkConfigs List<GetClustersClusterOptionKubernetesNetworkConfig>: Network configuration for Kubernetes.
openIdConnectDiscoveries List<GetClustersClusterOptionOpenIdConnectDiscovery>: The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs List<GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig>: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs List<GetClustersClusterOptionPersistentVolumeConfig>: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs List<GetClustersClusterOptionServiceLbConfig>: Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds List<String>: The OCIDs of the subnets used for Kubernetes services load balancers.

addOns GetClustersClusterOptionAddOn[]: Configurable cluster add-ons
admissionControllerOptions GetClustersClusterOptionAdmissionControllerOption[]: Configurable cluster admission controllers
ipFamilies 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).
kubernetesNetworkConfigs GetClustersClusterOptionKubernetesNetworkConfig[]: Network configuration for Kubernetes.
openIdConnectDiscoveries GetClustersClusterOptionOpenIdConnectDiscovery[]: The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig[]: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs GetClustersClusterOptionPersistentVolumeConfig[]: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs GetClustersClusterOptionServiceLbConfig[]: Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds string[]: The OCIDs of the subnets used for Kubernetes services load balancers.

add_ons Sequence[containerengine.GetClustersClusterOptionAddOn]: Configurable cluster add-ons
admission_controller_options Sequence[containerengine.GetClustersClusterOptionAdmissionControllerOption]: Configurable cluster admission controllers
ip_families 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_configs Sequence[containerengine.GetClustersClusterOptionKubernetesNetworkConfig]: Network configuration for Kubernetes.
open_id_connect_discoveries Sequence[containerengine.GetClustersClusterOptionOpenIdConnectDiscovery]: The property that define the status of the OIDC Discovery feature for a cluster.
open_id_connect_token_authentication_configs Sequence[containerengine.GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig]: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistent_volume_configs Sequence[containerengine.GetClustersClusterOptionPersistentVolumeConfig]: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
service_lb_configs Sequence[containerengine.GetClustersClusterOptionServiceLbConfig]: Configuration to be applied to load balancers created by Kubernetes services
service_lb_subnet_ids Sequence[str]: The OCIDs of the subnets used for Kubernetes services load balancers.

addOns List<Property Map>: Configurable cluster add-ons
admissionControllerOptions List<Property Map>: Configurable cluster admission controllers
ipFamilies 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).
kubernetesNetworkConfigs List<Property Map>: Network configuration for Kubernetes.
openIdConnectDiscoveries List<Property Map>: The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs List<Property Map>: The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs List<Property Map>: Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs List<Property Map>: Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds List<String>: The OCIDs of the subnets used for Kubernetes services load balancers.

GetClustersClusterOptionAddOn

IsKubernetesDashboardEnabled bool: Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled bool: Whether or not to enable the Tiller add-on.

IsKubernetesDashboardEnabled bool: Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled bool: Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled Boolean: Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled Boolean: Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled boolean: Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled boolean: Whether or not to enable the Tiller add-on.

is_kubernetes_dashboard_enabled bool: Whether or not to enable the Kubernetes Dashboard add-on.
is_tiller_enabled bool: Whether or not to enable the Tiller add-on.

isKubernetesDashboardEnabled Boolean: Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled Boolean: Whether or not to enable the Tiller add-on.

GetClustersClusterOptionAdmissionControllerOption

IsPodSecurityPolicyEnabled bool: Whether or not to enable the Pod Security Policy admission controller.

IsPodSecurityPolicyEnabled bool: Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled Boolean: Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled boolean: Whether or not to enable the Pod Security Policy admission controller.

is_pod_security_policy_enabled bool: Whether or not to enable the Pod Security Policy admission controller.

isPodSecurityPolicyEnabled Boolean: Whether or not to enable the Pod Security Policy admission controller.

GetClustersClusterOptionKubernetesNetworkConfig

PodsCidr 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 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 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 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 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 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 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 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 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 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 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 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.

GetClustersClusterOptionOpenIdConnectDiscovery

IsOpenIdConnectDiscoveryEnabled bool: 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: 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: 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: 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: 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: Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.

GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig

CaCertificate string: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId string: A client id that all tokens must be issued for.
ConfigurationFile string: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim string: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix string: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IsOpenIdConnectAuthEnabled bool: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
IssuerUrl string: 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<GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim>: 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>: The signing algorithms accepted. Default is ["RS256"].
UsernameClaim string: 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: 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.

CaCertificate string: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId string: A client id that all tokens must be issued for.
ConfigurationFile string: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim string: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix string: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IsOpenIdConnectAuthEnabled bool: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
IssuerUrl string: 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 []GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim: 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: The signing algorithms accepted. Default is ["RS256"].
UsernameClaim string: 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: 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.

caCertificate String: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId String: A client id that all tokens must be issued for.
configurationFile String: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim String: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix String: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled Boolean: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl String: 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<GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim>: 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>: The signing algorithms accepted. Default is ["RS256"].
usernameClaim String: 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: 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.

caCertificate string: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId string: A client id that all tokens must be issued for.
configurationFile string: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim string: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix string: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled boolean: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl string: 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 GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim[]: 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[]: The signing algorithms accepted. Default is ["RS256"].
usernameClaim string: 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: 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.

ca_certificate str: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
client_id str: A client id that all tokens must be issued for.
configuration_file str: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groups_claim str: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groups_prefix str: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
is_open_id_connect_auth_enabled bool: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuer_url str: 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.GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim]: 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]: The signing algorithms accepted. Default is ["RS256"].
username_claim str: 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: 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.

caCertificate String: A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId String: A client id that all tokens must be issued for.
configurationFile String: A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim String: JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix String: Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled Boolean: Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl String: 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>: 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>: The signing algorithms accepted. Default is ["RS256"].
usernameClaim String: 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: 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.

GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim

Key string: The key of the pair.
Value string: The value of the pair.

Key string: The key of the pair.
Value string: The value of the pair.

key String: The key of the pair.
value String: The value of the pair.

key string: The key of the pair.
value string: The value of the pair.

key str: The key of the pair.
value str: The value of the pair.

key String: The key of the pair.
value String: The value of the pair.

GetClustersClusterOptionPersistentVolumeConfig

DefinedTags Dictionary<string, string>: 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>: 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: 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: 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>: 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>: 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}: 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}: 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]: 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]: 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>: 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>: 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"}

GetClustersClusterOptionServiceLbConfig

DefinedTags Dictionary<string, string>: 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>: 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: 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: 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>: 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>: 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}: 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}: 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]: 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]: 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>: 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>: 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"}

GetClustersFilter

Name string: The name to filter on.
Values List<string>
Regex bool

Name string: The name to filter on.
Values []string
Regex bool

name String: The name to filter on.
values List<String>
regex Boolean

name string: The name to filter on.
values string[]
regex boolean

name str: The name to filter on.
values Sequence[str]
regex bool

name String: The name to filter on.
values List<String>
regex Boolean

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.ContainerEngine.getClusters

On this page

On this page

Example Usage

Using getClusters

getClusters Result

Supporting Types

GetClustersCluster

GetClustersClusterClusterPodNetworkOption

GetClustersClusterEndpoint

GetClustersClusterEndpointConfig

GetClustersClusterImagePolicyConfig

GetClustersClusterImagePolicyConfigKeyDetail

GetClustersClusterMetadata

GetClustersClusterOption

GetClustersClusterOptionAddOn

GetClustersClusterOptionAdmissionControllerOption

GetClustersClusterOptionKubernetesNetworkConfig

GetClustersClusterOptionOpenIdConnectDiscovery

GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig

GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim

GetClustersClusterOptionPersistentVolumeConfig

GetClustersClusterOptionServiceLbConfig

GetClustersFilter

Package Details

On this page

On this page