1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ContainerEngine
  5. getCluster
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.ContainerEngine.getCluster

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides details about a specific Cluster resource in Oracle Cloud Infrastructure Container Engine service.

Get the details of a cluster.

Example Usage

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

const testCluster = oci.ContainerEngine.getCluster({
    clusterId: testClusterOciContainerengineCluster.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_cluster = oci.ContainerEngine.get_cluster(cluster_id=test_cluster_oci_containerengine_cluster["id"])
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.GetCluster(ctx, &containerengine.GetClusterArgs{
			ClusterId: testClusterOciContainerengineCluster.Id,
		}, nil)
		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 = Oci.ContainerEngine.GetCluster.Invoke(new()
    {
        ClusterId = testClusterOciContainerengineCluster.Id,
    });

});
Copy
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.GetClusterArgs;
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 testCluster = ContainerEngineFunctions.getCluster(GetClusterArgs.builder()
            .clusterId(testClusterOciContainerengineCluster.id())
            .build());

    }
}
Copy
variables:
  testCluster:
    fn::invoke:
      function: oci:ContainerEngine:getCluster
      arguments:
        clusterId: ${testClusterOciContainerengineCluster.id}
Copy

Using getCluster

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.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
Copy
def get_cluster(cluster_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func GetCluster(ctx *Context, args *GetClusterArgs, opts ...InvokeOption) (*GetClusterResult, error)
func GetClusterOutput(ctx *Context, args *GetClusterOutputArgs, opts ...InvokeOption) GetClusterResultOutput
Copy

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:ContainerEngine/getCluster:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterId This property is required. string
The OCID of the cluster.
ClusterId This property is required. string
The OCID of the cluster.
clusterId This property is required. String
The OCID of the cluster.
clusterId This property is required. string
The OCID of the cluster.
cluster_id This property is required. str
The OCID of the cluster.
clusterId This property is required. String
The OCID of the cluster.

getCluster Result

The following output properties are available:

AvailableKubernetesUpgrades List<string>
Available Kubernetes versions to which the clusters masters may be upgraded.
ClusterId string
ClusterPodNetworkOptions List<GetClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
CompartmentId string
The OCID of the compartment in which the cluster exists.
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<GetClusterEndpointConfig>
The network configuration for access to the Cluster control plane.
Endpoints List<GetClusterEndpoint>
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<GetClusterImagePolicyConfig>
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<GetClusterMetadata>
Metadata about the cluster.
Name string
The name of the cluster.
OpenIdConnectDiscoveryEndpoint string
Options List<GetClusterOption>
Optional attributes for the cluster.
State string
The state of the cluster masters.
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.
ClusterId string
ClusterPodNetworkOptions []GetClusterClusterPodNetworkOption
Available CNIs and network options for existing and new node pools of the cluster
CompartmentId string
The OCID of the compartment in which the cluster exists.
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 []GetClusterEndpointConfig
The network configuration for access to the Cluster control plane.
Endpoints []GetClusterEndpoint
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 []GetClusterImagePolicyConfig
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 []GetClusterMetadata
Metadata about the cluster.
Name string
The name of the cluster.
OpenIdConnectDiscoveryEndpoint string
Options []GetClusterOption
Optional attributes for the cluster.
State string
The state of the cluster masters.
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.
clusterId String
clusterPodNetworkOptions List<GetClusterClusterPodNetworkOption>
Available CNIs and network options for existing and new node pools of the cluster
compartmentId String
The OCID of the compartment in which the cluster exists.
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<GetClusterEndpointConfig>
The network configuration for access to the Cluster control plane.
endpoints List<GetClusterEndpoint>
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<GetClusterImagePolicyConfig>
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<GetClusterMetadata>
Metadata about the cluster.
name String
The name of the cluster.
openIdConnectDiscoveryEndpoint String
options List<GetClusterOption>
Optional attributes for the cluster.
state String
The state of the cluster masters.
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.
clusterId string
clusterPodNetworkOptions GetClusterClusterPodNetworkOption[]
Available CNIs and network options for existing and new node pools of the cluster
compartmentId string
The OCID of the compartment in which the cluster exists.
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 GetClusterEndpointConfig[]
The network configuration for access to the Cluster control plane.
endpoints GetClusterEndpoint[]
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 GetClusterImagePolicyConfig[]
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 GetClusterMetadata[]
Metadata about the cluster.
name string
The name of the cluster.
openIdConnectDiscoveryEndpoint string
options GetClusterOption[]
Optional attributes for the cluster.
state string
The state of the cluster masters.
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_id str
cluster_pod_network_options Sequence[containerengine.GetClusterClusterPodNetworkOption]
Available CNIs and network options for existing and new node pools of the cluster
compartment_id str
The OCID of the compartment in which the cluster exists.
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.GetClusterEndpointConfig]
The network configuration for access to the Cluster control plane.
endpoints Sequence[containerengine.GetClusterEndpoint]
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.GetClusterImagePolicyConfig]
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.GetClusterMetadata]
Metadata about the cluster.
name str
The name of the cluster.
open_id_connect_discovery_endpoint str
options Sequence[containerengine.GetClusterOption]
Optional attributes for the cluster.
state str
The state of the cluster masters.
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.
clusterId String
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 in which the cluster exists.
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 of the cluster.
openIdConnectDiscoveryEndpoint String
options List<Property Map>
Optional attributes for the cluster.
state String
The state of the cluster masters.
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.

Supporting Types

GetClusterClusterPodNetworkOption

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

GetClusterEndpoint

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

GetClusterEndpointConfig

IsPublicIpEnabled This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.
is_public_ip_enabled This property is required. 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 This property is required. 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 This property is required. str
The OCID of the regional subnet in which to place the Cluster endpoint.
isPublicIpEnabled This property is required. 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 This property is required. 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.

GetClusterImagePolicyConfig

IsPolicyEnabled This property is required. 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 This property is required. List<GetClusterImagePolicyConfigKeyDetail>
A list of KMS key details.
IsPolicyEnabled This property is required. 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 This property is required. []GetClusterImagePolicyConfigKeyDetail
A list of KMS key details.
isPolicyEnabled This property is required. 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 This property is required. List<GetClusterImagePolicyConfigKeyDetail>
A list of KMS key details.
isPolicyEnabled This property is required. 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 This property is required. GetClusterImagePolicyConfigKeyDetail[]
A list of KMS key details.
is_policy_enabled This property is required. 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 This property is required. Sequence[containerengine.GetClusterImagePolicyConfigKeyDetail]
A list of KMS key details.
isPolicyEnabled This property is required. 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 This property is required. List<Property Map>
A list of KMS key details.

GetClusterImagePolicyConfigKeyDetail

KmsKeyId This property is required. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
KmsKeyId This property is required. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kmsKeyId This property is required. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kmsKeyId This property is required. string
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kms_key_id This property is required. str
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
kmsKeyId This property is required. String
The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

GetClusterMetadata

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

GetClusterOption

AddOns This property is required. List<GetClusterOptionAddOn>
Configurable cluster add-ons
AdmissionControllerOptions This property is required. List<GetClusterOptionAdmissionControllerOption>
Configurable cluster admission controllers
IpFamilies This property is required. 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 This property is required. List<GetClusterOptionKubernetesNetworkConfig>
Network configuration for Kubernetes.
OpenIdConnectDiscoveries This property is required. List<GetClusterOptionOpenIdConnectDiscovery>
The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfigs This property is required. List<GetClusterOptionOpenIdConnectTokenAuthenticationConfig>
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfigs This property is required. List<GetClusterOptionPersistentVolumeConfig>
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfigs This property is required. List<GetClusterOptionServiceLbConfig>
Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds This property is required. List<string>
The OCIDs of the subnets used for Kubernetes services load balancers.
AddOns This property is required. []GetClusterOptionAddOn
Configurable cluster add-ons
AdmissionControllerOptions This property is required. []GetClusterOptionAdmissionControllerOption
Configurable cluster admission controllers
IpFamilies This property is required. []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 This property is required. []GetClusterOptionKubernetesNetworkConfig
Network configuration for Kubernetes.
OpenIdConnectDiscoveries This property is required. []GetClusterOptionOpenIdConnectDiscovery
The property that define the status of the OIDC Discovery feature for a cluster.
OpenIdConnectTokenAuthenticationConfigs This property is required. []GetClusterOptionOpenIdConnectTokenAuthenticationConfig
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
PersistentVolumeConfigs This property is required. []GetClusterOptionPersistentVolumeConfig
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
ServiceLbConfigs This property is required. []GetClusterOptionServiceLbConfig
Configuration to be applied to load balancers created by Kubernetes services
ServiceLbSubnetIds This property is required. []string
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns This property is required. List<GetClusterOptionAddOn>
Configurable cluster add-ons
admissionControllerOptions This property is required. List<GetClusterOptionAdmissionControllerOption>
Configurable cluster admission controllers
ipFamilies This property is required. 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 This property is required. List<GetClusterOptionKubernetesNetworkConfig>
Network configuration for Kubernetes.
openIdConnectDiscoveries This property is required. List<GetClusterOptionOpenIdConnectDiscovery>
The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs This property is required. List<GetClusterOptionOpenIdConnectTokenAuthenticationConfig>
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs This property is required. List<GetClusterOptionPersistentVolumeConfig>
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs This property is required. List<GetClusterOptionServiceLbConfig>
Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds This property is required. List<String>
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns This property is required. GetClusterOptionAddOn[]
Configurable cluster add-ons
admissionControllerOptions This property is required. GetClusterOptionAdmissionControllerOption[]
Configurable cluster admission controllers
ipFamilies This property is required. 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 This property is required. GetClusterOptionKubernetesNetworkConfig[]
Network configuration for Kubernetes.
openIdConnectDiscoveries This property is required. GetClusterOptionOpenIdConnectDiscovery[]
The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs This property is required. GetClusterOptionOpenIdConnectTokenAuthenticationConfig[]
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs This property is required. GetClusterOptionPersistentVolumeConfig[]
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs This property is required. GetClusterOptionServiceLbConfig[]
Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds This property is required. string[]
The OCIDs of the subnets used for Kubernetes services load balancers.
add_ons This property is required. Sequence[containerengine.GetClusterOptionAddOn]
Configurable cluster add-ons
admission_controller_options This property is required. Sequence[containerengine.GetClusterOptionAdmissionControllerOption]
Configurable cluster admission controllers
ip_families This property is required. 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 This property is required. Sequence[containerengine.GetClusterOptionKubernetesNetworkConfig]
Network configuration for Kubernetes.
open_id_connect_discoveries This property is required. Sequence[containerengine.GetClusterOptionOpenIdConnectDiscovery]
The property that define the status of the OIDC Discovery feature for a cluster.
open_id_connect_token_authentication_configs This property is required. Sequence[containerengine.GetClusterOptionOpenIdConnectTokenAuthenticationConfig]
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistent_volume_configs This property is required. Sequence[containerengine.GetClusterOptionPersistentVolumeConfig]
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
service_lb_configs This property is required. Sequence[containerengine.GetClusterOptionServiceLbConfig]
Configuration to be applied to load balancers created by Kubernetes services
service_lb_subnet_ids This property is required. Sequence[str]
The OCIDs of the subnets used for Kubernetes services load balancers.
addOns This property is required. List<Property Map>
Configurable cluster add-ons
admissionControllerOptions This property is required. List<Property Map>
Configurable cluster admission controllers
ipFamilies This property is required. 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 This property is required. List<Property Map>
Network configuration for Kubernetes.
openIdConnectDiscoveries This property is required. List<Property Map>
The property that define the status of the OIDC Discovery feature for a cluster.
openIdConnectTokenAuthenticationConfigs This property is required. List<Property Map>
The properties that configure OIDC token authentication in kube-apiserver. For more information, see Configuring the API Server.
persistentVolumeConfigs This property is required. List<Property Map>
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
serviceLbConfigs This property is required. List<Property Map>
Configuration to be applied to load balancers created by Kubernetes services
serviceLbSubnetIds This property is required. List<String>
The OCIDs of the subnets used for Kubernetes services load balancers.

GetClusterOptionAddOn

IsKubernetesDashboardEnabled This property is required. bool
Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled This property is required. bool
Whether or not to enable the Tiller add-on.
IsKubernetesDashboardEnabled This property is required. bool
Whether or not to enable the Kubernetes Dashboard add-on.
IsTillerEnabled This property is required. bool
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled This property is required. Boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled This property is required. Boolean
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled This property is required. boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled This property is required. boolean
Whether or not to enable the Tiller add-on.
is_kubernetes_dashboard_enabled This property is required. bool
Whether or not to enable the Kubernetes Dashboard add-on.
is_tiller_enabled This property is required. bool
Whether or not to enable the Tiller add-on.
isKubernetesDashboardEnabled This property is required. Boolean
Whether or not to enable the Kubernetes Dashboard add-on.
isTillerEnabled This property is required. Boolean
Whether or not to enable the Tiller add-on.

GetClusterOptionAdmissionControllerOption

IsPodSecurityPolicyEnabled This property is required. bool
Whether or not to enable the Pod Security Policy admission controller.
IsPodSecurityPolicyEnabled This property is required. bool
Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled This property is required. Boolean
Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled This property is required. boolean
Whether or not to enable the Pod Security Policy admission controller.
is_pod_security_policy_enabled This property is required. bool
Whether or not to enable the Pod Security Policy admission controller.
isPodSecurityPolicyEnabled This property is required. Boolean
Whether or not to enable the Pod Security Policy admission controller.

GetClusterOptionKubernetesNetworkConfig

PodsCidr This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

GetClusterOptionOpenIdConnectDiscovery

IsOpenIdConnectDiscoveryEnabled This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

GetClusterOptionOpenIdConnectTokenAuthenticationConfig

CaCertificate This property is required. string
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId This property is required. string
A client id that all tokens must be issued for.
ConfigurationFile This property is required. string
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim This property is required. string
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix This property is required. string
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IsOpenIdConnectAuthEnabled This property is required. bool
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
IssuerUrl This property is required. 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 This property is required. List<GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim>
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 This property is required. List<string>
The signing algorithms accepted. Default is ["RS256"].
UsernameClaim This property is required. 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 This property is required. 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 This property is required. string
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
ClientId This property is required. string
A client id that all tokens must be issued for.
ConfigurationFile This property is required. string
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
GroupsClaim This property is required. string
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
GroupsPrefix This property is required. string
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
IsOpenIdConnectAuthEnabled This property is required. bool
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
IssuerUrl This property is required. 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 This property is required. []GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim
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 This property is required. []string
The signing algorithms accepted. Default is ["RS256"].
UsernameClaim This property is required. 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 This property is required. 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 This property is required. String
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId This property is required. String
A client id that all tokens must be issued for.
configurationFile This property is required. String
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim This property is required. String
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix This property is required. String
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled This property is required. Boolean
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl This property is required. 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 This property is required. List<GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim>
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 This property is required. List<String>
The signing algorithms accepted. Default is ["RS256"].
usernameClaim This property is required. 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 This property is required. 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 This property is required. string
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId This property is required. string
A client id that all tokens must be issued for.
configurationFile This property is required. string
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim This property is required. string
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix This property is required. string
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled This property is required. boolean
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl This property is required. 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 This property is required. GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim[]
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 This property is required. string[]
The signing algorithms accepted. Default is ["RS256"].
usernameClaim This property is required. 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 This property is required. 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 This property is required. str
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
client_id This property is required. str
A client id that all tokens must be issued for.
configuration_file This property is required. str
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groups_claim This property is required. str
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groups_prefix This property is required. str
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
is_open_id_connect_auth_enabled This property is required. bool
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuer_url This property is required. 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 This property is required. Sequence[containerengine.GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim]
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 This property is required. Sequence[str]
The signing algorithms accepted. Default is ["RS256"].
username_claim This property is required. 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 This property is required. 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 This property is required. String
A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
clientId This property is required. String
A client id that all tokens must be issued for.
configurationFile This property is required. String
A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
groupsClaim This property is required. String
JWT claim to use as the user's group. If the claim is present it must be an array of strings.
groupsPrefix This property is required. String
Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).
isOpenIdConnectAuthEnabled This property is required. Boolean
Whether the cluster has OIDC Auth Config enabled. Defaults to false.
issuerUrl This property is required. 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 This property is required. 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 This property is required. List<String>
The signing algorithms accepted. Default is ["RS256"].
usernameClaim This property is required. 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 This property is required. 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.

GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim

Key This property is required. string
The key of the pair.
Value This property is required. string
The value of the pair.
Key This property is required. string
The key of the pair.
Value This property is required. string
The value of the pair.
key This property is required. String
The key of the pair.
value This property is required. String
The value of the pair.
key This property is required. string
The key of the pair.
value This property is required. string
The value of the pair.
key This property is required. str
The key of the pair.
value This property is required. str
The value of the pair.
key This property is required. String
The key of the pair.
value This property is required. String
The value of the pair.

GetClusterOptionPersistentVolumeConfig

DefinedTags This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. {[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 This property is required. {[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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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"}

GetClusterOptionServiceLbConfig

DefinedTags This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. {[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 This property is required. {[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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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"}

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.30.0 published on Monday, Apr 14, 2025 by Pulumi