Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
oci.ContainerEngine.getCluster
Explore with Pulumi AI
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,
});
import pulumi
import pulumi_oci as oci
test_cluster = oci.ContainerEngine.get_cluster(cluster_id=test_cluster_oci_containerengine_cluster["id"])
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
})
}
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,
});
});
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());
}
}
variables:
testCluster:
fn::invoke:
function: oci:ContainerEngine:getCluster
arguments:
clusterId: ${testClusterOciContainerengineCluster.id}
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>
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]
func GetCluster(ctx *Context, args *GetClusterArgs, opts ...InvokeOption) (*GetClusterResult, error)
func GetClusterOutput(ctx *Context, args *GetClusterOutputArgs, opts ...InvokeOption) GetClusterResultOutput
> 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)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
fn::invoke:
function: oci:ContainerEngine/getCluster:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Id This property is required. string - The OCID of the cluster.
- Cluster
Id This property is required. string - The OCID of the cluster.
- cluster
Id This property is required. String - The OCID of the cluster.
- cluster
Id This property is required. string - The OCID of the cluster.
- cluster_
id This property is required. str - The OCID of the cluster.
- cluster
Id This property is required. String - The OCID of the cluster.
getCluster Result
The following output properties are available:
- Available
Kubernetes List<string>Upgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- Cluster
Id string - Cluster
Pod List<GetNetwork Options Cluster Cluster Pod Network Option> - Available CNIs and network options for existing and new node pools of the cluster
- Compartment
Id string - The OCID of the compartment in which the cluster exists.
- 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"}
- Endpoint
Configs List<GetCluster Endpoint Config> - The network configuration for access to the Cluster control plane.
- Endpoints
List<Get
Cluster Endpoint> - Endpoints served up by the cluster masters.
- 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.
- Image
Policy List<GetConfigs Cluster Image Policy Config> - The image verification policy for signature validation.
- Kms
Key stringId - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
- Kubernetes
Version string - The version of Kubernetes running on the cluster masters.
- Lifecycle
Details string - Details about the state of the cluster masters.
- Metadatas
List<Get
Cluster Metadata> - Metadata about the cluster.
- Name string
- The name of the cluster.
- Open
Id stringConnect Discovery Endpoint - Options
List<Get
Cluster Option> - 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
- Vcn
Id string - The OCID of the virtual cloud network (VCN) in which the cluster exists.
- Available
Kubernetes []stringUpgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- Cluster
Id string - Cluster
Pod []GetNetwork Options Cluster Cluster Pod Network Option - Available CNIs and network options for existing and new node pools of the cluster
- Compartment
Id string - The OCID of the compartment in which the cluster exists.
- 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"}
- Endpoint
Configs []GetCluster Endpoint Config - The network configuration for access to the Cluster control plane.
- Endpoints
[]Get
Cluster Endpoint - Endpoints served up by the cluster masters.
- 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.
- Image
Policy []GetConfigs Cluster Image Policy Config - The image verification policy for signature validation.
- Kms
Key stringId - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
- Kubernetes
Version string - The version of Kubernetes running on the cluster masters.
- Lifecycle
Details string - Details about the state of the cluster masters.
- Metadatas
[]Get
Cluster Metadata - Metadata about the cluster.
- Name string
- The name of the cluster.
- Open
Id stringConnect Discovery Endpoint - Options
[]Get
Cluster Option - 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
- Vcn
Id string - The OCID of the virtual cloud network (VCN) in which the cluster exists.
- available
Kubernetes List<String>Upgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- cluster
Id String - cluster
Pod List<GetNetwork Options Cluster Cluster Pod Network Option> - Available CNIs and network options for existing and new node pools of the cluster
- compartment
Id String - The OCID of the compartment in which the cluster exists.
- 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"}
- endpoint
Configs List<GetCluster Endpoint Config> - The network configuration for access to the Cluster control plane.
- endpoints
List<Get
Cluster Endpoint> - Endpoints served up by the cluster masters.
- 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.
- image
Policy List<GetConfigs Cluster Image Policy Config> - The image verification policy for signature validation.
- kms
Key StringId - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
- kubernetes
Version String - The version of Kubernetes running on the cluster masters.
- lifecycle
Details String - Details about the state of the cluster masters.
- metadatas
List<Get
Cluster Metadata> - Metadata about the cluster.
- name String
- The name of the cluster.
- open
Id StringConnect Discovery Endpoint - options
List<Get
Cluster Option> - 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
- vcn
Id String - The OCID of the virtual cloud network (VCN) in which the cluster exists.
- available
Kubernetes string[]Upgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- cluster
Id string - cluster
Pod GetNetwork Options Cluster Cluster Pod Network Option[] - Available CNIs and network options for existing and new node pools of the cluster
- compartment
Id string - The OCID of the compartment in which the cluster exists.
- {[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"}
- endpoint
Configs GetCluster Endpoint Config[] - The network configuration for access to the Cluster control plane.
- endpoints
Get
Cluster Endpoint[] - Endpoints served up by the cluster masters.
- {[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.
- image
Policy GetConfigs Cluster Image Policy Config[] - The image verification policy for signature validation.
- kms
Key stringId - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
- kubernetes
Version string - The version of Kubernetes running on the cluster masters.
- lifecycle
Details string - Details about the state of the cluster masters.
- metadatas
Get
Cluster Metadata[] - Metadata about the cluster.
- name string
- The name of the cluster.
- open
Id stringConnect Discovery Endpoint - options
Get
Cluster Option[] - 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
- vcn
Id string - The OCID of the virtual cloud network (VCN) in which the cluster exists.
- available_
kubernetes_ Sequence[str]upgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- cluster_
id str - cluster_
pod_ Sequence[containerengine.network_ options Get Cluster Cluster Pod Network Option] - 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.
- 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.Get Cluster Endpoint Config] - The network configuration for access to the Cluster control plane.
- endpoints
Sequence[containerengine.
Get Cluster Endpoint] - Endpoints served up by the cluster masters.
- 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_ Sequence[containerengine.configs Get Cluster Image Policy Config] - The image verification policy for signature validation.
- kms_
key_ strid - 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.
Get Cluster Metadata] - Metadata about the cluster.
- name str
- The name of the cluster.
- open_
id_ strconnect_ discovery_ endpoint - options
Sequence[containerengine.
Get Cluster Option] - 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.
- available
Kubernetes List<String>Upgrades - Available Kubernetes versions to which the clusters masters may be upgraded.
- cluster
Id String - cluster
Pod List<Property Map>Network Options - Available CNIs and network options for existing and new node pools of the cluster
- compartment
Id String - The OCID of the compartment in which the cluster exists.
- 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"}
- endpoint
Configs List<Property Map> - The network configuration for access to the Cluster control plane.
- endpoints List<Property Map>
- Endpoints served up by the cluster masters.
- 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.
- image
Policy List<Property Map>Configs - The image verification policy for signature validation.
- kms
Key StringId - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
- kubernetes
Version String - The version of Kubernetes running on the cluster masters.
- lifecycle
Details String - Details about the state of the cluster masters.
- metadatas List<Property Map>
- Metadata about the cluster.
- name String
- The name of the cluster.
- open
Id StringConnect Discovery Endpoint - 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
- vcn
Id String - The OCID of the virtual cloud network (VCN) in which the cluster exists.
Supporting Types
GetClusterClusterPodNetworkOption
- Cni
Type This property is required. string - The CNI used by the node pools of this cluster
- Cni
Type This property is required. string - The CNI used by the node pools of this cluster
- cni
Type This property is required. String - The CNI used by the node pools of this cluster
- cni
Type 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
- cni
Type 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.
- Private
Endpoint This property is required. string - The private native networking Kubernetes API server endpoint.
- Public
Endpoint This property is required. string - The public native networking Kubernetes API server endpoint, if one was requested.
- Vcn
Hostname Endpoint 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.
- Private
Endpoint This property is required. string - The private native networking Kubernetes API server endpoint.
- Public
Endpoint This property is required. string - The public native networking Kubernetes API server endpoint, if one was requested.
- Vcn
Hostname Endpoint 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.
- private
Endpoint This property is required. String - The private native networking Kubernetes API server endpoint.
- public
Endpoint This property is required. String - The public native networking Kubernetes API server endpoint, if one was requested.
- vcn
Hostname Endpoint 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.
- private
Endpoint This property is required. string - The private native networking Kubernetes API server endpoint.
- public
Endpoint This property is required. string - The public native networking Kubernetes API server endpoint, if one was requested.
- vcn
Hostname Endpoint 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.
- private
Endpoint This property is required. String - The private native networking Kubernetes API server endpoint.
- public
Endpoint This property is required. String - The public native networking Kubernetes API server endpoint, if one was requested.
- vcn
Hostname Endpoint This property is required. String - The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'
GetClusterEndpointConfig
- 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. 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.
- Subnet
Id 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. []string - A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NetworkSecurityGroup.
- Subnet
Id This property is required. string - The OCID of the regional subnet in which to place the Cluster endpoint.
- is
Public Ip Enabled 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.
- nsg
Ids 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.
- subnet
Id 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. 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.
- nsg
Ids 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.
- subnet
Id 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.
- is
Public Ip Enabled 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.
- nsg
Ids 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.
- subnet
Id This property is required. String - The OCID of the regional subnet in which to place the Cluster endpoint.
GetClusterImagePolicyConfig
- 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. List<GetCluster Image Policy Config Key Detail> - 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. []GetCluster Image Policy Config Key Detail - A list of KMS key details.
- is
Policy Enabled 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.
- key
Details This property is required. List<GetCluster Image Policy Config Key Detail> - A list of KMS key details.
- is
Policy Enabled 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.
- key
Details This property is required. GetCluster Image Policy Config Key Detail[] - 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.Get Cluster Image Policy Config Key Detail] - A list of KMS key details.
- is
Policy Enabled 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.
- key
Details This property is required. List<Property Map> - A list of KMS key details.
GetClusterImagePolicyConfigKeyDetail
- Kms
Key Id 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. 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. 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. 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.
- kms
Key Id This property is required. String - The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.
GetClusterMetadata
- Created
By User Id This property is required. string - The user who created the cluster.
- Created
By Work Request Id This property is required. string - The OCID of the work request which created the cluster.
- Deleted
By User Id This property is required. string - The user who deleted the cluster.
- Deleted
By Work Request Id This property is required. string - The OCID of the work request which deleted the cluster.
- Time
Created This property is required. string - The time the cluster was created.
- Time
Credential Expiration This property is required. string - The time until which the cluster credential is valid.
- Time
Deleted This property is required. string - The time the cluster was deleted.
- Time
Updated This property is required. string - The time the cluster was updated.
- Updated
By User Id This property is required. string - The user who updated the cluster.
- Updated
By Work Request Id This property is required. string - The OCID of the work request which updated the cluster.
- Created
By User Id This property is required. string - The user who created the cluster.
- Created
By Work Request Id This property is required. string - The OCID of the work request which created the cluster.
- Deleted
By User Id This property is required. string - The user who deleted the cluster.
- Deleted
By Work Request Id This property is required. string - The OCID of the work request which deleted the cluster.
- Time
Created This property is required. string - The time the cluster was created.
- Time
Credential Expiration This property is required. string - The time until which the cluster credential is valid.
- Time
Deleted This property is required. string - The time the cluster was deleted.
- Time
Updated This property is required. string - The time the cluster was updated.
- Updated
By User Id This property is required. string - The user who updated the cluster.
- Updated
By Work Request Id This property is required. string - The OCID of the work request which updated the cluster.
- created
By User Id This property is required. String - The user who created the cluster.
- created
By Work Request Id This property is required. String - The OCID of the work request which created the cluster.
- deleted
By User Id This property is required. String - The user who deleted the cluster.
- deleted
By Work Request Id This property is required. String - The OCID of the work request which deleted the cluster.
- time
Created This property is required. String - The time the cluster was created.
- time
Credential Expiration This property is required. String - The time until which the cluster credential is valid.
- time
Deleted This property is required. String - The time the cluster was deleted.
- time
Updated This property is required. String - The time the cluster was updated.
- updated
By User Id This property is required. String - The user who updated the cluster.
- updated
By Work Request Id This property is required. String - The OCID of the work request which updated the cluster.
- created
By User Id This property is required. string - The user who created the cluster.
- created
By Work Request Id This property is required. string - The OCID of the work request which created the cluster.
- deleted
By User Id This property is required. string - The user who deleted the cluster.
- deleted
By Work Request Id This property is required. string - The OCID of the work request which deleted the cluster.
- time
Created This property is required. string - The time the cluster was created.
- time
Credential Expiration This property is required. string - The time until which the cluster credential is valid.
- time
Deleted This property is required. string - The time the cluster was deleted.
- time
Updated This property is required. string - The time the cluster was updated.
- updated
By User Id This property is required. string - The user who updated the cluster.
- updated
By Work Request Id 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.
- created
By User Id This property is required. String - The user who created the cluster.
- created
By Work Request Id This property is required. String - The OCID of the work request which created the cluster.
- deleted
By User Id This property is required. String - The user who deleted the cluster.
- deleted
By Work Request Id This property is required. String - The OCID of the work request which deleted the cluster.
- time
Created This property is required. String - The time the cluster was created.
- time
Credential Expiration This property is required. String - The time until which the cluster credential is valid.
- time
Deleted This property is required. String - The time the cluster was deleted.
- time
Updated This property is required. String - The time the cluster was updated.
- updated
By User Id This property is required. String - The user who updated the cluster.
- updated
By Work Request Id This property is required. String - The OCID of the work request which updated the cluster.
GetClusterOption
- Add
Ons This property is required. List<GetCluster Option Add On> - Configurable cluster add-ons
- Admission
Controller Options This property is required. List<GetCluster Option Admission Controller Option> - Configurable cluster admission controllers
- Ip
Families 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).
- Kubernetes
Network Configs This property is required. List<GetCluster Option Kubernetes Network Config> - Network configuration for Kubernetes.
- Open
Id Connect Discoveries This property is required. List<GetCluster Option Open Id Connect Discovery> - The property that define the status of the OIDC Discovery feature for a cluster.
- Open
Id Connect Token Authentication Configs This property is required. List<GetCluster Option Open Id Connect Token Authentication Config> - 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. List<GetCluster Option Persistent Volume Config> - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- Service
Lb Configs This property is required. List<GetCluster Option Service Lb Config> - Configuration to be applied to load balancers created by Kubernetes services
- Service
Lb Subnet Ids This property is required. List<string> - The OCIDs of the subnets used for Kubernetes services load balancers.
- Add
Ons This property is required. []GetCluster Option Add On - Configurable cluster add-ons
- Admission
Controller Options This property is required. []GetCluster Option Admission Controller Option - Configurable cluster admission controllers
- Ip
Families 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).
- Kubernetes
Network Configs This property is required. []GetCluster Option Kubernetes Network Config - Network configuration for Kubernetes.
- Open
Id Connect Discoveries This property is required. []GetCluster Option Open Id Connect Discovery - The property that define the status of the OIDC Discovery feature for a cluster.
- Open
Id Connect Token Authentication Configs This property is required. []GetCluster Option Open Id Connect Token Authentication Config - 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. []GetCluster Option Persistent Volume Config - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- Service
Lb Configs This property is required. []GetCluster Option Service Lb Config - Configuration to be applied to load balancers created by Kubernetes services
- Service
Lb Subnet Ids This property is required. []string - The OCIDs of the subnets used for Kubernetes services load balancers.
- add
Ons This property is required. List<GetCluster Option Add On> - Configurable cluster add-ons
- admission
Controller Options This property is required. List<GetCluster Option Admission Controller Option> - Configurable cluster admission controllers
- ip
Families 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).
- kubernetes
Network Configs This property is required. List<GetCluster Option Kubernetes Network Config> - Network configuration for Kubernetes.
- open
Id Connect Discoveries This property is required. List<GetCluster Option Open Id Connect Discovery> - The property that define the status of the OIDC Discovery feature for a cluster.
- open
Id Connect Token Authentication Configs This property is required. List<GetCluster Option Open Id Connect Token Authentication Config> - 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. List<GetCluster Option Persistent Volume Config> - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- service
Lb Configs This property is required. List<GetCluster Option Service Lb Config> - Configuration to be applied to load balancers created by Kubernetes services
- service
Lb Subnet Ids This property is required. List<String> - The OCIDs of the subnets used for Kubernetes services load balancers.
- add
Ons This property is required. GetCluster Option Add On[] - Configurable cluster add-ons
- admission
Controller Options This property is required. GetCluster Option Admission Controller Option[] - Configurable cluster admission controllers
- ip
Families 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).
- kubernetes
Network Configs This property is required. GetCluster Option Kubernetes Network Config[] - Network configuration for Kubernetes.
- open
Id Connect Discoveries This property is required. GetCluster Option Open Id Connect Discovery[] - The property that define the status of the OIDC Discovery feature for a cluster.
- open
Id Connect Token Authentication Configs This property is required. GetCluster Option Open Id Connect Token Authentication Config[] - 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. GetCluster Option Persistent Volume Config[] - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- service
Lb Configs This property is required. GetCluster Option Service Lb Config[] - Configuration to be applied to load balancers created by Kubernetes services
- service
Lb Subnet Ids This property is required. string[] - The OCIDs of the subnets used for Kubernetes services load balancers.
- add_
ons This property is required. Sequence[containerengine.Get Cluster Option Add On] - Configurable cluster add-ons
- admission_
controller_ options This property is required. Sequence[containerengine.Get Cluster Option Admission Controller Option] - 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.Get Cluster Option Kubernetes Network Config] - Network configuration for Kubernetes.
- open_
id_ connect_ discoveries This property is required. Sequence[containerengine.Get Cluster Option Open Id Connect Discovery] - 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.Get Cluster Option Open Id Connect Token Authentication Config] - 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.Get Cluster Option Persistent Volume Config] - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- service_
lb_ configs This property is required. Sequence[containerengine.Get Cluster Option Service Lb Config] - 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.
- add
Ons This property is required. List<Property Map> - Configurable cluster add-ons
- admission
Controller Options This property is required. List<Property Map> - Configurable cluster admission controllers
- ip
Families 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).
- kubernetes
Network Configs This property is required. List<Property Map> - Network configuration for Kubernetes.
- open
Id Connect Discoveries This property is required. List<Property Map> - The property that define the status of the OIDC Discovery feature for a cluster.
- open
Id Connect Token Authentication Configs 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.
- persistent
Volume Configs This property is required. List<Property Map> - Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
- service
Lb Configs This property is required. List<Property Map> - Configuration to be applied to load balancers created by Kubernetes services
- service
Lb Subnet Ids This property is required. List<String> - The OCIDs of the subnets used for Kubernetes services load balancers.
GetClusterOptionAddOn
- 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.
- 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.
- is
Kubernetes Dashboard Enabled This property is required. Boolean - Whether or not to enable the Kubernetes Dashboard add-on.
- is
Tiller Enabled This property is required. Boolean - Whether or not to enable the Tiller add-on.
- is
Kubernetes Dashboard Enabled This property is required. boolean - Whether or not to enable the Kubernetes Dashboard add-on.
- is
Tiller Enabled 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.
- is
Kubernetes Dashboard Enabled This property is required. Boolean - Whether or not to enable the Kubernetes Dashboard add-on.
- is
Tiller Enabled This property is required. Boolean - Whether or not to enable the Tiller add-on.
GetClusterOptionAdmissionControllerOption
- Is
Pod Security Policy Enabled This property is required. bool - 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.
- is
Pod Security Policy Enabled 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. 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.
- is
Pod Security Policy Enabled This property is required. Boolean - Whether or not to enable the Pod Security Policy admission controller.
GetClusterOptionKubernetesNetworkConfig
- Pods
Cidr 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.
- Services
Cidr 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. 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.
- Services
Cidr 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. 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.
- services
Cidr 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. 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.
- services
Cidr 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.
- pods
Cidr 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.
- services
Cidr 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
- 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.
- 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.
- is
Open Id Connect Discovery Enabled 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. 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.
- is
Open Id Connect Discovery Enabled 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
- Ca
Certificate This property is required. string - A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
- Client
Id This property is required. string - A client id that all tokens must be issued for.
- Configuration
File This property is required. string - A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
- Groups
Claim 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.
- Groups
Prefix This property is required. string - 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. 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.
- Required
Claims This property is required. List<GetCluster Option Open Id Connect Token Authentication Config Required Claim> - 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. List<string> - The signing algorithms accepted. Default is ["RS256"].
- Username
Claim 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.
- Username
Prefix 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. string - A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
- Client
Id This property is required. string - A client id that all tokens must be issued for.
- Configuration
File This property is required. string - A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
- Groups
Claim 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.
- Groups
Prefix This property is required. string - 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. 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.
- Required
Claims This property is required. []GetCluster Option Open Id Connect Token Authentication Config Required Claim - 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. []string - The signing algorithms accepted. Default is ["RS256"].
- Username
Claim 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.
- Username
Prefix 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. String - A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
- client
Id This property is required. String - A client id that all tokens must be issued for.
- configuration
File This property is required. String - A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
- groups
Claim 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.
- groups
Prefix This property is required. String - 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. Boolean - Whether the cluster has OIDC Auth Config enabled. Defaults to false.
- issuer
Url 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.
- required
Claims This property is required. List<GetCluster Option Open Id Connect Token Authentication Config Required Claim> - 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. List<String> - The signing algorithms accepted. Default is ["RS256"].
- username
Claim 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.
- username
Prefix 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. string - A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
- client
Id This property is required. string - A client id that all tokens must be issued for.
- configuration
File This property is required. string - A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
- groups
Claim 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.
- groups
Prefix This property is required. string - 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. boolean - Whether the cluster has OIDC Auth Config enabled. Defaults to false.
- issuer
Url 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.
- required
Claims This property is required. GetCluster Option Open Id Connect Token Authentication Config Required Claim[] - 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. string[] - The signing algorithms accepted. Default is ["RS256"].
- username
Claim 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.
- username
Prefix 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.Get Cluster Option Open Id Connect Token Authentication Config Required Claim] - 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.
- ca
Certificate This property is required. String - A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.
- client
Id This property is required. String - A client id that all tokens must be issued for.
- configuration
File This property is required. String - A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info here
- groups
Claim 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.
- groups
Prefix This property is required. String - 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. Boolean - Whether the cluster has OIDC Auth Config enabled. Defaults to false.
- issuer
Url 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.
- required
Claims 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.
- signing
Algorithms This property is required. List<String> - The signing algorithms accepted. Default is ["RS256"].
- username
Claim 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.
- username
Prefix 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
GetClusterOptionPersistentVolumeConfig
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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"}
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.