Container Engine Common Types

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADD_ON_OPTIONS_T Type

The properties that define options for supported add-ons.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_add_on_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_kubernetes_dashboard_enabled number,
  is_tiller_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_add_on_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_add_on_options_t (
    is_kubernetes_dashboard_enabled number,
    is_tiller_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_kubernetes_dashboard_enabled

(optional) Whether or not to enable the Kubernetes Dashboard add-on.

is_tiller_enabled

(optional) Whether or not to enable the Tiller add-on.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_CONFIGURATION_T Type

Defines the configuration of available addons for a cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_configuration_t (
    key varchar2,
    value varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) configuration key name

value

(optional) configuration value name

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_ERROR_T Type

The error info of the addon.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  status varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_error_t (
    code varchar2,
    message varchar2,
    status varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(optional) A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.

message

(optional) A human-readable error string of the upstream error.

status

(optional) The status of the HTTP response encountered in the upstream error.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_CONFIGURATION_TBL Type

Nested table type of dbms_cloud_oci_container_engine_addon_configuration_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_configuration_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_addon_configuration_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_T Type

The properties that define an addon.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  version varchar2(32767),
  current_installed_version varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  configurations dbms_cloud_oci_container_engine_addon_configuration_tbl,
  addon_error dbms_cloud_oci_container_engine_addon_error_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_t (
    name varchar2,
    version varchar2,
    current_installed_version varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    configurations dbms_cloud_oci_container_engine_addon_configuration_tbl,
    addon_error dbms_cloud_oci_container_engine_addon_error_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the addon.

version

(optional) selected addon version, or null indicates autoUpdate

current_installed_version

(optional) current installed version of the addon

time_created

(optional) The time the cluster was created.

lifecycle_state

(required) The state of the addon.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'UPDATING', 'NEEDS_ATTENTION', 'FAILED'

configurations

(optional) Addon configuration details.

addon_error

(optional) The error info of the addon.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KUBERNETES_VERSIONS_FILTERS_T Type

The range of kubernetes versions an addon can be configured.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_kubernetes_versions_filters_t FORCE AUTHID CURRENT_USER IS OBJECT (
  minimal_version varchar2(32767),
  maximum_version varchar2(32767),
  exact_kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_kubernetes_versions_filters_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_kubernetes_versions_filters_t (
    minimal_version varchar2,
    maximum_version varchar2,
    exact_kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

minimal_version

(optional) The earliest kubernetes version.

maximum_version

(optional) The latest kubernetes version.

exact_kubernetes_versions

(optional) The exact version of kubernetes that are compatible.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_VERSION_CONFIGURATION_T Type

Addon version configuration details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_version_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_required number,
  key varchar2(32767),
  value varchar2(32767),
  display_name varchar2(32767),
  description varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_version_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_version_configuration_t (
    is_required number,
    key varchar2,
    value varchar2,
    display_name varchar2,
    description varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_required

(optional) If the the configuration is required or not.

key

(optional) Addon configuration key

value

(optional) Addon configuration value

display_name

(optional) Display name of addon version.

description

(optional) Information about the addon version configuration.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_VERSION_CONFIGURATION_TBL Type

Nested table type of dbms_cloud_oci_container_engine_addon_version_configuration_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_version_configuration_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_addon_version_configuration_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_VERSIONS_T Type

The properties that define a work request resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_versions_t FORCE AUTHID CURRENT_USER IS OBJECT (
  status varchar2(32767),
  version_number varchar2(32767),
  description varchar2(32767),
  kubernetes_version_filters dbms_cloud_oci_container_engine_kubernetes_versions_filters_t,
  configurations dbms_cloud_oci_container_engine_addon_version_configuration_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_versions_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_versions_t (
    status varchar2,
    version_number varchar2,
    description varchar2,
    kubernetes_version_filters dbms_cloud_oci_container_engine_kubernetes_versions_filters_t,
    configurations dbms_cloud_oci_container_engine_addon_version_configuration_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

status

(optional) Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.

Allowed values are: 'ACTIVE', 'DEPRECATED', 'PREVIEW', 'RECALLED'

version_number

(optional) Version number, need be comparable within an addon.

description

(optional) Information about the addon version.

kubernetes_version_filters

(optional) The range of kubernetes versions an addon can be configured.

configurations

(optional) Addon version configuration details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_VERSIONS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_addon_versions_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_versions_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_addon_versions_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_OPTION_SUMMARY_T Type

The properties that define addon summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_option_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  addon_schema_version varchar2(32767),
  addon_group varchar2(32767),
  lifecycle_state varchar2(32767),
  description varchar2(32767),
  is_essential number,
  versions dbms_cloud_oci_container_engine_addon_versions_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  time_created timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_option_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_option_summary_t (
    name varchar2,
    addon_schema_version varchar2,
    addon_group varchar2,
    lifecycle_state varchar2,
    description varchar2,
    is_essential number,
    versions dbms_cloud_oci_container_engine_addon_versions_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    time_created timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Name of the addon and it would be unique.

addon_schema_version

(optional) Addon definition schema version to validate addon.

addon_group

(optional) Addon group info, a namespace concept that groups addons with similar functionalities.

lifecycle_state

(required) The life cycle state of the addon.

Allowed values are: 'ACTIVE', 'INACTIVE'

description

(optional) Description on the addon.

is_essential

(required) Is it an essential addon for cluster operation or not.

versions

(required) The resources this work request affects.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

time_created

(optional) The time the work request was created.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADDON_SUMMARY_T Type

The properties that define an addon summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_addon_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  version varchar2(32767),
  current_installed_version varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  addon_error dbms_cloud_oci_container_engine_addon_error_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_addon_summary_t (
    name varchar2,
    version varchar2,
    current_installed_version varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    addon_error dbms_cloud_oci_container_engine_addon_error_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the addon.

version

(optional) selected addon version, or null indicates autoUpdate

current_installed_version

(optional) current installed version of the addon

time_created

(optional) The time the cluster was created.

lifecycle_state

(required) The state of the addon.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'UPDATING', 'NEEDS_ATTENTION', 'FAILED'

addon_error

(optional) The error info of the addon.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ADMISSION_CONTROLLER_OPTIONS_T Type

The properties that define supported admission controllers.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_admission_controller_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_pod_security_policy_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_admission_controller_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_admission_controller_options_t (
    is_pod_security_policy_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_pod_security_policy_enabled

(optional) Whether or not to enable the Pod Security Policy admission controller.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_ENDPOINT_CONFIG_T Type

The properties that define the network configuration for the Cluster endpoint.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_endpoint_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  is_public_ip_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_endpoint_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_endpoint_config_t (
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    is_public_ip_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subnet_id

(optional) The OCID of the regional subnet in which to place the Cluster endpoint.

nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

is_public_ip_enabled

(optional) 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.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KUBERNETES_NETWORK_CONFIG_T Type

The properties that define the network configuration for Kubernetes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_kubernetes_network_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  pods_cidr varchar2(32767),
  services_cidr varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_kubernetes_network_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_kubernetes_network_config_t (
    pods_cidr varchar2,
    services_cidr varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

pods_cidr

(optional) The CIDR block for Kubernetes pods. Optional, defaults to 10.244.0.0/16.

services_cidr

(optional) The CIDR block for Kubernetes services. Optional, defaults to 10.96.0.0/16.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_PERSISTENT_VOLUME_CONFIG_DETAILS_T Type

Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_persistent_volume_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_persistent_volume_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_persistent_volume_config_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SERVICE_LB_CONFIG_DETAILS_T Type

Configuration to be applied to load balancers created by Kubernetes services

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_service_lb_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_service_lb_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_service_lb_config_details_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_CREATE_OPTIONS_T Type

The properties that define extra options for a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_create_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  service_lb_subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  kubernetes_network_config dbms_cloud_oci_container_engine_kubernetes_network_config_t,
  add_ons dbms_cloud_oci_container_engine_add_on_options_t,
  admission_controller_options dbms_cloud_oci_container_engine_admission_controller_options_t,
  persistent_volume_config dbms_cloud_oci_container_engine_persistent_volume_config_details_t,
  service_lb_config dbms_cloud_oci_container_engine_service_lb_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_create_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_create_options_t (
    service_lb_subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    kubernetes_network_config dbms_cloud_oci_container_engine_kubernetes_network_config_t,
    add_ons dbms_cloud_oci_container_engine_add_on_options_t,
    admission_controller_options dbms_cloud_oci_container_engine_admission_controller_options_t,
    persistent_volume_config dbms_cloud_oci_container_engine_persistent_volume_config_details_t,
    service_lb_config dbms_cloud_oci_container_engine_service_lb_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

service_lb_subnet_ids

(optional) The OCIDs of the subnets used for Kubernetes services load balancers.

kubernetes_network_config

(optional) Network configuration for Kubernetes.

add_ons

(optional) Configurable cluster add-ons

admission_controller_options

(optional) Configurable cluster admission controllers

persistent_volume_config

(optional)

service_lb_config

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_METADATA_T Type

The properties that define meta data for a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_metadata_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_created timestamp with time zone,
  created_by_user_id varchar2(32767),
  created_by_work_request_id varchar2(32767),
  time_deleted timestamp with time zone,
  deleted_by_user_id varchar2(32767),
  deleted_by_work_request_id varchar2(32767),
  time_updated timestamp with time zone,
  updated_by_user_id varchar2(32767),
  updated_by_work_request_id varchar2(32767),
  time_credential_expiration timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_metadata_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_metadata_t (
    time_created timestamp with time zone,
    created_by_user_id varchar2,
    created_by_work_request_id varchar2,
    time_deleted timestamp with time zone,
    deleted_by_user_id varchar2,
    deleted_by_work_request_id varchar2,
    time_updated timestamp with time zone,
    updated_by_user_id varchar2,
    updated_by_work_request_id varchar2,
    time_credential_expiration timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_created

(optional) The time the cluster was created.

created_by_user_id

(optional) The user who created the cluster.

created_by_work_request_id

(optional) The OCID of the work request which created the cluster.

time_deleted

(optional) The time the cluster was deleted.

deleted_by_user_id

(optional) The user who deleted the cluster.

deleted_by_work_request_id

(optional) The OCID of the work request which deleted the cluster.

time_updated

(optional) The time the cluster was updated.

updated_by_user_id

(optional) The user who updated the cluster.

updated_by_work_request_id

(optional) The OCID of the work request which updated the cluster.

time_credential_expiration

(optional) The time until which the cluster credential is valid.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_ENDPOINTS_T Type

The properties that define endpoints for a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_endpoints_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kubernetes varchar2(32767),
  public_endpoint varchar2(32767),
  private_endpoint varchar2(32767),
  vcn_hostname_endpoint varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_endpoints_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_endpoints_t (
    kubernetes varchar2,
    public_endpoint varchar2,
    private_endpoint varchar2,
    vcn_hostname_endpoint varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kubernetes

(optional) The non-native networking Kubernetes API server endpoint.

public_endpoint

(optional) The public native networking Kubernetes API server endpoint, if one was requested.

private_endpoint

(optional) The private native networking Kubernetes API server endpoint.

vcn_hostname_endpoint

(optional) The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KEY_DETAILS_T Type

The properties that define the kms keys used by OKE for Image Signature verification.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kms_key_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_key_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_key_details_t (
    kms_key_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kms_key_id

(optional) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KEY_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_key_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_key_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_key_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_IMAGE_POLICY_CONFIG_T Type

The properties that define a image verification policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_image_policy_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_policy_enabled number,
  key_details dbms_cloud_oci_container_engine_key_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_image_policy_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_image_policy_config_t (
    is_policy_enabled number,
    key_details dbms_cloud_oci_container_engine_key_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_policy_enabled

(optional) 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

(optional) A list of KMS key details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_POD_NETWORK_OPTION_DETAILS_T Type

The CNI type and relevant network details potentially applicable to the node pools of the cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cni_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t (
    cni_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

cni_type

(required) The CNI used by the node pools of this cluster

Allowed values are: 'OCI_VCN_IP_NATIVE', 'FLANNEL_OVERLAY'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_POD_NETWORK_OPTION_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_T Type

A Kubernetes cluster. Avoid entering confidential information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
  vcn_id varchar2(32767),
  kubernetes_version varchar2(32767),
  kms_key_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  options dbms_cloud_oci_container_engine_cluster_create_options_t,
  metadata dbms_cloud_oci_container_engine_cluster_metadata_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  endpoints dbms_cloud_oci_container_engine_cluster_endpoints_t,
  available_kubernetes_upgrades dbms_cloud_oci_container_engine_varchar2_tbl,
  image_policy_config dbms_cloud_oci_container_engine_image_policy_config_t,
  cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_t (
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
    vcn_id varchar2,
    kubernetes_version varchar2,
    kms_key_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    options dbms_cloud_oci_container_engine_cluster_create_options_t,
    metadata dbms_cloud_oci_container_engine_cluster_metadata_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    endpoints dbms_cloud_oci_container_engine_cluster_endpoints_t,
    available_kubernetes_upgrades dbms_cloud_oci_container_engine_varchar2_tbl,
    image_policy_config dbms_cloud_oci_container_engine_image_policy_config_t,
    cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the cluster.

name

(optional) The name of the cluster.

compartment_id

(optional) The OCID of the compartment in which the cluster exists.

endpoint_config

(optional) The network configuration for access to the Cluster control plane.

vcn_id

(optional) The OCID of the virtual cloud network (VCN) in which the cluster exists.

kubernetes_version

(optional) The version of Kubernetes running on the cluster masters.

kms_key_id

(optional) The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

options

(optional) Optional attributes for the cluster.

metadata

(optional) Metadata about the cluster.

lifecycle_state

(optional) The state of the cluster masters.

Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'

lifecycle_details

(optional) Details about the state of the cluster masters.

endpoints

(optional) Endpoints served up by the cluster masters.

available_kubernetes_upgrades

(optional) Available Kubernetes versions to which the clusters masters may be upgraded.

image_policy_config

(optional) The image verification policy for signature validation.

cluster_pod_network_options

(optional) Available CNIs and network options for existing and new node pools of the cluster

l_type

(optional) Type of cluster

Allowed values are: 'BASIC_CLUSTER', 'ENHANCED_CLUSTER'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_MIGRATE_TO_NATIVE_VCN_DETAILS_T Type

The properties that define a request to migrate a cluster to Native VCN.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
  decommission_delay_duration varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_details_t (
    endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
    decommission_delay_duration varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

endpoint_config

(required) The network configuration for access to the Cluster control plane.

decommission_delay_duration

(optional) The optional override of the non-native endpoint decommission time after migration is complete. Defaults to 30 days.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_MIGRATE_TO_NATIVE_VCN_STATUS_T Type

Information regarding a cluster's move to Native VCN.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_status_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_decommission_scheduled timestamp with time zone,
  state varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_status_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_status_t (
    time_decommission_scheduled timestamp with time zone,
    state varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_decommission_scheduled

(optional) The date and time the non-native VCN is due to be decommissioned.

state

(required) The current migration status of the cluster.

Allowed values are: 'NOT_STARTED', 'REQUESTED', 'IN_PROGRESS', 'PENDING_DECOMMISSION', 'COMPLETED'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_OPTIONS_T Type

Options for creating or updating clusters.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl,
  cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_options_t (
    kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl,
    cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kubernetes_versions

(optional) Available Kubernetes versions.

cluster_pod_network_options

(optional) Available CNIs and network options for existing and new node pools of the cluster

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CLUSTER_SUMMARY_T Type

The properties that define a cluster summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_cluster_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
  vcn_id varchar2(32767),
  kubernetes_version varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  options dbms_cloud_oci_container_engine_cluster_create_options_t,
  metadata dbms_cloud_oci_container_engine_cluster_metadata_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  endpoints dbms_cloud_oci_container_engine_cluster_endpoints_t,
  available_kubernetes_upgrades dbms_cloud_oci_container_engine_varchar2_tbl,
  image_policy_config dbms_cloud_oci_container_engine_image_policy_config_t,
  cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_cluster_summary_t (
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    endpoint_config dbms_cloud_oci_container_engine_cluster_endpoint_config_t,
    vcn_id varchar2,
    kubernetes_version varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    options dbms_cloud_oci_container_engine_cluster_create_options_t,
    metadata dbms_cloud_oci_container_engine_cluster_metadata_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    endpoints dbms_cloud_oci_container_engine_cluster_endpoints_t,
    available_kubernetes_upgrades dbms_cloud_oci_container_engine_varchar2_tbl,
    image_policy_config dbms_cloud_oci_container_engine_image_policy_config_t,
    cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the cluster.

name

(optional) The name of the cluster.

compartment_id

(optional) The OCID of the compartment in which the cluster exists.

endpoint_config

(optional) The network configuration for access to the Cluster control plane.

vcn_id

(optional) The OCID of the virtual cloud network (VCN) in which the cluster exists

kubernetes_version

(optional) The version of Kubernetes running on the cluster masters.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

options

(optional) Optional attributes for the cluster.

metadata

(optional) Metadata about the cluster.

lifecycle_state

(optional) The state of the cluster masters.

Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'

lifecycle_details

(optional) Details about the state of the cluster masters.

endpoints

(optional) Endpoints served up by the cluster masters.

available_kubernetes_upgrades

(optional) Available Kubernetes versions to which the clusters masters may be upgraded.

image_policy_config

(optional) The image verification policy for signature validation.

cluster_pod_network_options

(optional) Available CNIs and network options for existing and new node pools of the cluster

l_type

(optional) Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see Cluster Types

Allowed values are: 'BASIC_CLUSTER', 'ENHANCED_CLUSTER'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_CLUSTER_ENDPOINT_CONFIG_DETAILS_T Type

The properties that define the network configuration for the Cluster endpoint.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_cluster_endpoint_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  is_public_ip_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_endpoint_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_endpoint_config_details_t (
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    is_public_ip_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subnet_id

(optional) The OCID of the regional subnet in which to place the Cluster endpoint.

nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

is_public_ip_enabled

(optional) 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.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_IMAGE_POLICY_CONFIG_DETAILS_T Type

The properties that define a image verification policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_image_policy_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_policy_enabled number,
  key_details dbms_cloud_oci_container_engine_key_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_image_policy_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_image_policy_config_details_t (
    is_policy_enabled number,
    key_details dbms_cloud_oci_container_engine_key_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_policy_enabled

(optional) 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

(optional) A list of KMS key details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_CLUSTER_DETAILS_T Type

The properties that define a request to create a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  compartment_id varchar2(32767),
  endpoint_config dbms_cloud_oci_container_engine_create_cluster_endpoint_config_details_t,
  vcn_id varchar2(32767),
  kubernetes_version varchar2(32767),
  kms_key_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  options dbms_cloud_oci_container_engine_cluster_create_options_t,
  image_policy_config dbms_cloud_oci_container_engine_create_image_policy_config_details_t,
  cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_details_t (
    name varchar2,
    compartment_id varchar2,
    endpoint_config dbms_cloud_oci_container_engine_create_cluster_endpoint_config_details_t,
    vcn_id varchar2,
    kubernetes_version varchar2,
    kms_key_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    options dbms_cloud_oci_container_engine_cluster_create_options_t,
    image_policy_config dbms_cloud_oci_container_engine_create_image_policy_config_details_t,
    cluster_pod_network_options dbms_cloud_oci_container_engine_cluster_pod_network_option_details_tbl,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the cluster. Avoid entering confidential information.

compartment_id

(required) The OCID of the compartment in which to create the cluster.

endpoint_config

(optional) The network configuration for access to the Cluster control plane.

vcn_id

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

kubernetes_version

(required) The version of Kubernetes to install into the cluster masters.

kms_key_id

(optional) The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. When used, `kubernetesVersion` must be at least `v1.13.0`.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

options

(optional) Optional attributes for the cluster.

image_policy_config

(optional) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.

cluster_pod_network_options

(optional) Available CNIs and network options for existing and new node pools of the cluster

l_type

(optional) Type of cluster

Allowed values are: 'BASIC_CLUSTER', 'ENHANCED_CLUSTER'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_CLUSTER_KUBECONFIG_CONTENT_DETAILS_T Type

The properties that define a request to create a cluster kubeconfig.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_cluster_kubeconfig_content_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  token_version varchar2(32767),
  expiration number,
  endpoint varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_kubeconfig_content_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_cluster_kubeconfig_content_details_t (
    token_version varchar2,
    expiration number,
    endpoint varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

token_version

(optional) The version of the kubeconfig token. Supported value 2.0.0

expiration

(optional) Deprecated. This field is no longer used.

endpoint

(optional) The endpoint to target. A cluster may have multiple endpoints exposed but the kubeconfig can only target one at a time.

Allowed values are: 'LEGACY_KUBERNETES', 'PUBLIC_ENDPOINT', 'PRIVATE_ENDPOINT', 'VCN_HOSTNAME'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SOURCE_DETAILS_T Type

The details of the node's source.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_source_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_details_t (
    source_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

source_type

(required) The source type for the node. Use `IMAGE` when specifying an OCID of an image.

Allowed values are: 'IMAGE'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_NODE_SHAPE_CONFIG_DETAILS_T Type

The shape configuration of the nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_node_shape_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ocpus number,
  memory_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_shape_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_shape_config_details_t (
    ocpus number,
    memory_in_g_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

ocpus

(optional) The total number of OCPUs available to each node in the node pool. See here for details.

memory_in_g_bs

(optional) The total amount of memory available to each node, in gigabytes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KEY_VALUE_T Type

The properties that define a key value pair.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_key_value_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_key_value_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_key_value_t (
    key varchar2,
    value varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) The key of the pair.

value

(optional) The value of the pair.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_PREEMPTION_ACTION_T Type

The action to run when the preemptible node is interrupted for eviction.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_preemption_action_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_preemption_action_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_preemption_action_t (
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

l_type

(required) The type of action to run when the instance is interrupted for eviction.

Allowed values are: 'TERMINATE'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_PREEMPTIBLE_NODE_CONFIG_DETAILS_T Type

Configuration options for preemptible nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_preemptible_node_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  preemption_action dbms_cloud_oci_container_engine_preemption_action_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_preemptible_node_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_preemptible_node_config_details_t (
    preemption_action dbms_cloud_oci_container_engine_preemption_action_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

preemption_action

(required)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_PLACEMENT_CONFIG_DETAILS_T Type

The location where a node pool will place nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_placement_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  capacity_reservation_id varchar2(32767),
  preemptible_node_config dbms_cloud_oci_container_engine_preemptible_node_config_details_t,
  fault_domains dbms_cloud_oci_container_engine_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_placement_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_placement_config_details_t (
    availability_domain varchar2,
    subnet_id varchar2,
    capacity_reservation_id varchar2,
    preemptible_node_config dbms_cloud_oci_container_engine_preemptible_node_config_details_t,
    fault_domains dbms_cloud_oci_container_engine_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

availability_domain

(required) The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`

subnet_id

(required) The OCID of the subnet in which to place nodes.

capacity_reservation_id

(optional) The OCID of the compute capacity reservation in which to place the compute instance.

preemptible_node_config

(optional)

fault_domains

(optional) A list of fault domains in which to place nodes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_POD_NETWORK_OPTION_DETAILS_T Type

The CNI type and relevant network details for the pods of a given node pool

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  cni_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t (
    cni_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

cni_type

(required) The CNI plugin used by this node pool

Allowed values are: 'OCI_VCN_IP_NATIVE', 'FLANNEL_OVERLAY'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_PLACEMENT_CONFIG_DETAILS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_node_pool_placement_config_details_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_node_pool_placement_config_details_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_NODE_POOL_NODE_CONFIG_DETAILS_T Type

The size and placement configuration of nodes in the node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_node_pool_node_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_size number,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  kms_key_id varchar2(32767),
  is_pv_encryption_in_transit_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
  node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_pool_node_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_pool_node_config_details_t (
    l_size number,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    kms_key_id varchar2,
    is_pv_encryption_in_transit_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
    node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_size

(required) The number of nodes that should be in the node pool.

nsg_ids

(optional) The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

kms_key_id

(optional) The OCID of the Key Management Service key assigned to the boot volume.

is_pv_encryption_in_transit_enabled

(optional) Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

placement_configs

(required) The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.

node_pool_pod_network_option_details

(optional) The CNI related configuration of pods in the node pool.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_EVICTION_NODE_POOL_SETTINGS_T Type

Node Eviction Details configuration

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t FORCE AUTHID CURRENT_USER IS OBJECT (
  eviction_grace_duration varchar2(32767),
  is_force_delete_after_grace_duration number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t (
    eviction_grace_duration varchar2,
    is_force_delete_after_grace_duration number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

eviction_grace_duration

(optional) Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M

is_force_delete_after_grace_duration

(optional) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_CYCLING_DETAILS_T Type

Node Pool Cycling Details

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_cycling_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  maximum_unavailable varchar2(32767),
  maximum_surge varchar2(32767),
  is_node_cycling_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_cycling_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_cycling_details_t (
    maximum_unavailable varchar2,
    maximum_surge varchar2,
    is_node_cycling_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

maximum_unavailable

(optional) Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%

maximum_surge

(optional) Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%

is_node_cycling_enabled

(optional) If nodes in the nodepool will be cycled to have new changes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_KEY_VALUE_TBL Type

Nested table type of dbms_cloud_oci_container_engine_key_value_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_key_value_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_key_value_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_NODE_POOL_DETAILS_T Type

The properties that define a request to create a node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_node_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  node_metadata json_element_t,
  node_image_name varchar2(32767),
  node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
  node_shape varchar2(32767),
  node_shape_config dbms_cloud_oci_container_engine_create_node_shape_config_details_t,
  initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
  ssh_public_key varchar2(32767),
  quantity_per_subnet number,
  subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  node_config_details dbms_cloud_oci_container_engine_create_node_pool_node_config_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
  node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_node_pool_details_t (
    compartment_id varchar2,
    cluster_id varchar2,
    name varchar2,
    kubernetes_version varchar2,
    node_metadata json_element_t,
    node_image_name varchar2,
    node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
    node_shape varchar2,
    node_shape_config dbms_cloud_oci_container_engine_create_node_shape_config_details_t,
    initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
    ssh_public_key varchar2,
    quantity_per_subnet number,
    subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    node_config_details dbms_cloud_oci_container_engine_create_node_pool_node_config_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
    node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The OCID of the compartment in which the node pool exists.

cluster_id

(required) The OCID of the cluster to which this node pool is attached.

name

(required) The name of the node pool. Avoid entering confidential information.

kubernetes_version

(optional) The version of Kubernetes to install on the nodes in the node pool.

node_metadata

(optional) A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

node_image_name

(optional) Deprecated. Use `nodeSourceDetails` instead. If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool.

node_source_details

(optional) Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

node_shape

(required) The name of the node shape of the nodes in the node pool.

node_shape_config

(optional) Specify the configuration of the shape to launch nodes in the node pool.

initial_node_labels

(optional) A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

ssh_public_key

(optional) The SSH public key on each node in the node pool on launch.

quantity_per_subnet

(optional) Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead.

subnet_ids

(optional) The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

node_config_details

(optional) The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

node_eviction_node_pool_settings

(optional)

node_pool_cycling_details

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_INITIAL_VIRTUAL_NODE_LABEL_T Type

The properties that define a key value pair.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_initial_virtual_node_label_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_initial_virtual_node_label_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_initial_virtual_node_label_t (
    key varchar2,
    value varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) The key of the pair.

value

(optional) The value of the pair.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_TAINT_T Type

taints

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_taint_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  value varchar2(32767),
  effect varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_taint_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_taint_t (
    key varchar2,
    value varchar2,
    effect varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) The key of the pair.

value

(optional) The value of the pair.

effect

(optional) The effect of the pair.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_PLACEMENT_CONFIGURATION_T Type

The information of virtual node placement in the virtual node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_placement_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  availability_domain varchar2(32767),
  fault_domain dbms_cloud_oci_container_engine_varchar2_tbl,
  subnet_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_placement_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_placement_configuration_t (
    availability_domain varchar2,
    fault_domain dbms_cloud_oci_container_engine_varchar2_tbl,
    subnet_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

availability_domain

(optional) The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1`

fault_domain

(optional) The fault domain of this virtual node.

subnet_id

(optional) The OCID of the subnet in which to place virtual nodes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_POD_CONFIGURATION_T Type

The pod configuration for pods run on virtual nodes of this virtual node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_pod_configuration_t FORCE AUTHID CURRENT_USER IS OBJECT (
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  shape varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_configuration_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_configuration_t (
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    shape varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

subnet_id

(required) The regional subnet where pods' VNIC will be placed.

nsg_ids

(optional) List of network security group IDs applied to the Pod VNIC.

shape

(required) Shape of the pods.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VIRTUAL_NODE_TAGS_T Type

The tags associated to the virtual nodes in this virtual node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_virtual_node_tags_t FORCE AUTHID CURRENT_USER IS OBJECT (
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_tags_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_tags_t (
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_INITIAL_VIRTUAL_NODE_LABEL_TBL Type

Nested table type of dbms_cloud_oci_container_engine_initial_virtual_node_label_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_initial_virtual_node_label_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_TAINT_TBL Type

Nested table type of dbms_cloud_oci_container_engine_taint_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_taint_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_taint_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_PLACEMENT_CONFIGURATION_TBL Type

Nested table type of dbms_cloud_oci_container_engine_placement_configuration_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_placement_configuration_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_placement_configuration_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_VIRTUAL_NODE_POOL_DETAILS_T Type

The properties that define a request to create a virtual node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_virtual_node_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  display_name varchar2(32767),
  initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
  taints dbms_cloud_oci_container_engine_taint_tbl,
  l_size number,
  placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_virtual_node_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_virtual_node_pool_details_t (
    compartment_id varchar2,
    cluster_id varchar2,
    display_name varchar2,
    initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
    taints dbms_cloud_oci_container_engine_taint_tbl,
    l_size number,
    placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) Compartment of the virtual node pool.

cluster_id

(required) The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

display_name

(required) Display name of the virtual node pool. This is a non-unique value.

initial_virtual_node_labels

(optional) Initial labels that will be added to the Kubernetes Virtual Node object when it registers.

taints

(optional) A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.

l_size

(optional) The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

placement_configurations

(required) The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations

nsg_ids

(optional) List of network security group id's applied to the Virtual Node VNIC.

pod_configuration

(optional) The pod configuration for pods run on virtual nodes of this virtual node pool.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

virtual_node_tags

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREATE_WORKLOAD_MAPPING_DETAILS_T Type

The properties that define a workloadMapping

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_create_workload_mapping_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  namespace varchar2(32767),
  mapped_compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_workload_mapping_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_create_workload_mapping_details_t (
    namespace varchar2,
    mapped_compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

namespace

(required) The namespace of the workloadMapping.

mapped_compartment_id

(required) The OCID of the mapped customer compartment.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_CREDENTIAL_ROTATION_STATUS_T Type

Information regarding cluster's credential rotation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_credential_rotation_status_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_auto_completion_scheduled timestamp with time zone,
  status varchar2(32767),
  status_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_credential_rotation_status_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_credential_rotation_status_t (
    time_auto_completion_scheduled timestamp with time zone,
    status varchar2,
    status_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_auto_completion_scheduled

(optional) The time by which retirement of old credentials should start.

status

(required) Credential rotation status of a kubernetes cluster IN_PROGRESS: Issuing new credentials to kubernetes cluster control plane and worker nodes or retiring old credentials from kubernetes cluster control plane and worker nodes. WAITING: Waiting for customer to invoke the complete rotation action or the automcatic complete rotation action. COMPLETED: New credentials are functional on kuberentes cluster.

Allowed values are: 'IN_PROGRESS', 'WAITING', 'COMPLETED'

status_details

(required) Details of a kuberenetes cluster credential rotation status: ISSUING_NEW_CREDENTIALS: Credential rotation is in progress. Starting to issue new credentials to kubernetes cluster control plane and worker nodes. NEW_CREDENTIALS_ISSUED: New credentials are added. At this stage cluster has both old and new credentials and is awaiting old credentials retirement. RETIRING_OLD_CREDENTIALS: Retirement of old credentials is in progress. Starting to remove old credentials from kubernetes cluster control plane and worker nodes. COMPLETED: Credential rotation is complete. Old credentials are retired.

Allowed values are: 'ISSUING_NEW_CREDENTIALS', 'NEW_CREDENTIALS_ISSUED', 'RETIRING_OLD_CREDENTIALS', 'COMPLETED'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_ERROR_T Type

The properties that define an error.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_FLANNEL_OVERLAY_CLUSTER_POD_NETWORK_OPTION_DETAILS_T Type

Network options specific to using the flannel (FLANNEL_OVERLAY) CNI

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_flannel_overlay_cluster_pod_network_option_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_flannel_overlay_cluster_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_flannel_overlay_cluster_pod_network_option_details_t (
    cni_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_flannel_overlay_cluster_pod_network_option_details_t is a subtype of the dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t type.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_FLANNEL_OVERLAY_NODE_POOL_POD_NETWORK_OPTION_DETAILS_T Type

Network options specific to using the flannel (FLANNEL_OVERLAY) CNI

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_flannel_overlay_node_pool_pod_network_option_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_flannel_overlay_node_pool_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_flannel_overlay_node_pool_pod_network_option_details_t (
    cni_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_flannel_overlay_node_pool_pod_network_option_details_t is a subtype of the dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t type.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_INSTALL_ADDON_DETAILS_T Type

The properties that define to install/enable addon on a cluster

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_install_addon_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  addon_name varchar2(32767),
  version varchar2(32767),
  configurations dbms_cloud_oci_container_engine_addon_configuration_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_install_addon_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_install_addon_details_t (
    addon_name varchar2,
    version varchar2,
    configurations dbms_cloud_oci_container_engine_addon_configuration_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

addon_name

(required) The name of the addon.

version

(optional) The version of addon to be installed.

configurations

(optional) Addon configuration details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_ERROR_T Type

The properties that define an upstream error while managing a node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  status varchar2(32767),
  opc_request_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_error_t (
    code varchar2,
    message varchar2,
    status varchar2,
    opc_request_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string of the upstream error.

status

(optional) The status of the HTTP response encountered in the upstream error.

opc_request_id

(optional) Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_T Type

The properties that define a node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  availability_domain varchar2(32767),
  subnet_id varchar2(32767),
  node_pool_id varchar2(32767),
  fault_domain varchar2(32767),
  private_ip varchar2(32767),
  public_ip varchar2(32767),
  node_error dbms_cloud_oci_container_engine_node_error_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_t (
    id varchar2,
    name varchar2,
    kubernetes_version varchar2,
    availability_domain varchar2,
    subnet_id varchar2,
    node_pool_id varchar2,
    fault_domain varchar2,
    private_ip varchar2,
    public_ip varchar2,
    node_error dbms_cloud_oci_container_engine_node_error_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the compute instance backing this node.

name

(optional) The name of the node.

kubernetes_version

(optional) The version of Kubernetes this node is running.

availability_domain

(optional) The name of the availability domain in which this node is placed.

subnet_id

(optional) The OCID of the subnet in which this node is placed.

node_pool_id

(optional) The OCID of the node pool to which this node belongs.

fault_domain

(optional) The fault domain of this node.

private_ip

(optional) The private IP address of this node.

public_ip

(optional) The public IP address of this node.

node_error

(optional) An error that may be associated with the node.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

lifecycle_state

(optional) The state of the node.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILING', 'INACTIVE'

lifecycle_details

(optional) Details about the state of the node.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SHAPE_CONFIG_T Type

The shape configuration of the nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_shape_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ocpus number,
  memory_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_shape_config_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_shape_config_t (
    ocpus number,
    memory_in_g_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

ocpus

(optional) The total number of OCPUs available to each node in the node pool. See here for details.

memory_in_g_bs

(optional) The total amount of memory available to each node, in gigabytes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SOURCE_OPTION_T Type

The source option for the node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_source_option_t FORCE AUTHID CURRENT_USER IS OBJECT (
  source_type varchar2(32767),
  source_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_option_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_option_t (
    source_type varchar2,
    source_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

source_type

(required) The source type of this option. `IMAGE` means the OCID is of an image.

Allowed values are: 'IMAGE'

source_name

(optional) The user-friendly name of the entity corresponding to the OCID.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_NODE_CONFIG_DETAILS_T Type

The size and placement configuration of nodes in the node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_node_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_size number,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  kms_key_id varchar2(32767),
  is_pv_encryption_in_transit_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
  node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_node_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_node_config_details_t (
    l_size number,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    kms_key_id varchar2,
    is_pv_encryption_in_transit_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
    node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_size

(optional) The number of nodes in the node pool.

nsg_ids

(optional) The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

kms_key_id

(optional) The OCID of the Key Management Service key assigned to the boot volume.

is_pv_encryption_in_transit_enabled

(optional) Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

placement_configs

(optional) The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.

node_pool_pod_network_option_details

(optional) The CNI related configuration of pods in the node pool.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_TBL Type

Nested table type of dbms_cloud_oci_container_engine_node_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_node_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_T Type

A pool of compute nodes attached to a cluster. Avoid entering confidential information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  node_metadata json_element_t,
  node_image_id varchar2(32767),
  node_image_name varchar2(32767),
  node_shape_config dbms_cloud_oci_container_engine_node_shape_config_t,
  node_source dbms_cloud_oci_container_engine_node_source_option_t,
  node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
  node_shape varchar2(32767),
  initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
  ssh_public_key varchar2(32767),
  quantity_per_subnet number,
  subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  nodes dbms_cloud_oci_container_engine_node_tbl,
  node_config_details dbms_cloud_oci_container_engine_node_pool_node_config_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
  node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_t (
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    compartment_id varchar2,
    cluster_id varchar2,
    name varchar2,
    kubernetes_version varchar2,
    node_metadata json_element_t,
    node_image_id varchar2,
    node_image_name varchar2,
    node_shape_config dbms_cloud_oci_container_engine_node_shape_config_t,
    node_source dbms_cloud_oci_container_engine_node_source_option_t,
    node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
    node_shape varchar2,
    initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
    ssh_public_key varchar2,
    quantity_per_subnet number,
    subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    nodes dbms_cloud_oci_container_engine_node_tbl,
    node_config_details dbms_cloud_oci_container_engine_node_pool_node_config_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
    node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the node pool.

lifecycle_state

(optional) The state of the nodepool.

Allowed values are: 'DELETED', 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'FAILED', 'INACTIVE', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the nodepool.

compartment_id

(optional) The OCID of the compartment in which the node pool exists.

cluster_id

(optional) The OCID of the cluster to which this node pool is attached.

name

(optional) The name of the node pool.

kubernetes_version

(optional) The version of Kubernetes running on the nodes in the node pool.

node_metadata

(optional) A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

node_image_id

(optional) Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.

node_image_name

(optional) Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.

node_shape_config

(optional) The shape configuration of the nodes.

node_source

(optional) Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.

node_source_details

(optional) Source running on the nodes in the node pool.

node_shape

(optional) The name of the node shape of the nodes in the node pool.

initial_node_labels

(optional) A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

ssh_public_key

(optional) The SSH public key on each node in the node pool on launch.

quantity_per_subnet

(optional) The number of nodes in each subnet.

subnet_ids

(optional) The OCIDs of the subnets in which to place nodes for this node pool.

nodes

(optional) The nodes in the node pool.

node_config_details

(optional) The configuration of nodes in the node pool.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

node_eviction_node_pool_settings

(optional)

node_pool_cycling_details

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SOURCE_OPTION_TBL Type

Nested table type of dbms_cloud_oci_container_engine_node_source_option_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_source_option_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_node_source_option_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_OPTIONS_T Type

Options for creating or updating node pools.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl,
  shapes dbms_cloud_oci_container_engine_varchar2_tbl,
  images dbms_cloud_oci_container_engine_varchar2_tbl,
  sources dbms_cloud_oci_container_engine_node_source_option_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_options_t (
    kubernetes_versions dbms_cloud_oci_container_engine_varchar2_tbl,
    shapes dbms_cloud_oci_container_engine_varchar2_tbl,
    images dbms_cloud_oci_container_engine_varchar2_tbl,
    sources dbms_cloud_oci_container_engine_node_source_option_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

kubernetes_versions

(optional) Available Kubernetes versions.

shapes

(optional) Available shapes for nodes.

images

(optional) Deprecated. See sources. When creating a node pool using the `CreateNodePoolDetails` object, only image names contained in this property can be passed to the `nodeImageName` property.

sources

(optional) Available source of the node.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_POOL_SUMMARY_T Type

The properties that define a node pool summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_pool_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  node_image_id varchar2(32767),
  node_image_name varchar2(32767),
  node_shape_config dbms_cloud_oci_container_engine_node_shape_config_t,
  node_source dbms_cloud_oci_container_engine_node_source_option_t,
  node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
  node_shape varchar2(32767),
  initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
  ssh_public_key varchar2(32767),
  quantity_per_subnet number,
  subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  node_config_details dbms_cloud_oci_container_engine_node_pool_node_config_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
  node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_pool_summary_t (
    id varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    compartment_id varchar2,
    cluster_id varchar2,
    name varchar2,
    kubernetes_version varchar2,
    node_image_id varchar2,
    node_image_name varchar2,
    node_shape_config dbms_cloud_oci_container_engine_node_shape_config_t,
    node_source dbms_cloud_oci_container_engine_node_source_option_t,
    node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
    node_shape varchar2,
    initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
    ssh_public_key varchar2,
    quantity_per_subnet number,
    subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    node_config_details dbms_cloud_oci_container_engine_node_pool_node_config_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
    node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the node pool.

lifecycle_state

(optional) The state of the nodepool.

Allowed values are: 'DELETED', 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'FAILED', 'INACTIVE', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the nodepool.

compartment_id

(optional) The OCID of the compartment in which the node pool exists.

cluster_id

(optional) The OCID of the cluster to which this node pool is attached.

name

(optional) The name of the node pool.

kubernetes_version

(optional) The version of Kubernetes running on the nodes in the node pool.

node_image_id

(optional) Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.

node_image_name

(optional) Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.

node_shape_config

(optional) The shape configuration of the nodes.

node_source

(optional) Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.

node_source_details

(optional) Source running on the nodes in the node pool.

node_shape

(optional) The name of the node shape of the nodes in the node pool.

initial_node_labels

(optional) A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

ssh_public_key

(optional) The SSH public key on each node in the node pool on launch.

quantity_per_subnet

(optional) The number of nodes in each subnet.

subnet_ids

(optional) The OCIDs of the subnets in which to place nodes for this node pool.

node_config_details

(optional) The configuration of nodes in the node pool.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

node_eviction_node_pool_settings

(optional)

node_pool_cycling_details

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SOURCE_VIA_IMAGE_DETAILS_T Type

Details of the image running on the node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_source_via_image_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_node_source_details_t (
  image_id varchar2(32767),
  boot_volume_size_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_via_image_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_via_image_details_t (
    source_type varchar2,
    image_id varchar2,
    boot_volume_size_in_g_bs number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_node_source_via_image_details_t is a subtype of the dbms_cloud_oci_container_engine_node_source_details_t type.

Fields

Field Description

image_id

(required) The OCID of the image used to boot the node.

boot_volume_size_in_g_bs

(optional) The size of the boot volume in GBs. Minimum value is 50 GB. See here for max custom boot volume sizing and OS-specific requirements.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_NODE_SOURCE_VIA_IMAGE_OPTION_T Type

An image can be specified as the source of nodes when launching a node pool using the `nodeSourceDetails` object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_node_source_via_image_option_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_node_source_option_t (
  image_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_via_image_option_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_node_source_via_image_option_t (
    source_type varchar2,
    source_name varchar2,
    image_id varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_node_source_via_image_option_t is a subtype of the dbms_cloud_oci_container_engine_node_source_option_t type.

Fields

Field Description

image_id

(optional) The OCID of the image.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_OCI_VCN_IP_NATIVE_CLUSTER_POD_NETWORK_OPTION_DETAILS_T Type

Network options specific to using the OCI VCN Native CNI

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_oci_vcn_ip_native_cluster_pod_network_option_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_oci_vcn_ip_native_cluster_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_oci_vcn_ip_native_cluster_pod_network_option_details_t (
    cni_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_oci_vcn_ip_native_cluster_pod_network_option_details_t is a subtype of the dbms_cloud_oci_container_engine_cluster_pod_network_option_details_t type.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_OCI_VCN_IP_NATIVE_NODE_POOL_POD_NETWORK_OPTION_DETAILS_T Type

Network options specific to using the OCI VCN Native CNI

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_oci_vcn_ip_native_node_pool_pod_network_option_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t (
  max_pods_per_node number,
  pod_nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  pod_subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_oci_vcn_ip_native_node_pool_pod_network_option_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_oci_vcn_ip_native_node_pool_pod_network_option_details_t (
    cni_type varchar2,
    max_pods_per_node number,
    pod_nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    pod_subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_oci_vcn_ip_native_node_pool_pod_network_option_details_t is a subtype of the dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t type.

Fields

Field Description

max_pods_per_node

(optional) The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape

pod_nsg_ids

(optional) The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

pod_subnet_ids

(required) The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_OCPU_OPTIONS_T Type

Properties of OCPUs.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_ocpu_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_min number,
  l_max number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_ocpu_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_ocpu_options_t (
    l_min number,
    l_max number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_min

(optional) The minimum number of OCPUs.

l_max

(optional) The maximum number of OCPUs.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_MEMORY_OPTIONS_T Type

Memory properties.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_memory_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  min_in_g_bs number,
  max_in_g_bs number,
  default_per_ocpu_in_g_bs number,
  min_per_ocpu_in_g_bs number,
  max_per_ocpu_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_memory_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_memory_options_t (
    min_in_g_bs number,
    max_in_g_bs number,
    default_per_ocpu_in_g_bs number,
    min_per_ocpu_in_g_bs number,
    max_per_ocpu_in_g_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

min_in_g_bs

(optional) The minimum amount of memory, in gigabytes.

max_in_g_bs

(optional) The maximum amount of memory, in gigabytes.

default_per_ocpu_in_g_bs

(optional) The default amount of memory per OCPU available for this shape, in gigabytes.

min_per_ocpu_in_g_bs

(optional) The minimum amount of memory per OCPU available for this shape, in gigabytes.

max_per_ocpu_in_g_bs

(optional) The maximum amount of memory per OCPU available for this shape, in gigabytes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_NETWORK_BANDWIDTH_OPTIONS_T Type

Properties of network bandwidth.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_network_bandwidth_options_t FORCE AUTHID CURRENT_USER IS OBJECT (
  min_in_gbps number,
  max_in_gbps number,
  default_per_ocpu_in_gbps number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_network_bandwidth_options_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_shape_network_bandwidth_options_t (
    min_in_gbps number,
    max_in_gbps number,
    default_per_ocpu_in_gbps number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

min_in_gbps

(optional) The minimum amount of networking bandwidth, in gigabits per second.

max_in_gbps

(optional) The maximum amount of networking bandwidth, in gigabits per second.

default_per_ocpu_in_gbps

(optional) The default amount of networking bandwidth per OCPU, in gigabits per second.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_OCPU_OPTIONS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_shape_ocpu_options_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_ocpu_options_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_shape_ocpu_options_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_MEMORY_OPTIONS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_shape_memory_options_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_memory_options_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_shape_memory_options_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_SHAPE_NETWORK_BANDWIDTH_OPTIONS_TBL Type

Nested table type of dbms_cloud_oci_container_engine_shape_network_bandwidth_options_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_shape_network_bandwidth_options_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_shape_network_bandwidth_options_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_POD_SHAPE_T Type

Pod shape.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_pod_shape_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  processor_description varchar2(32767),
  ocpu_options dbms_cloud_oci_container_engine_shape_ocpu_options_tbl,
  memory_options dbms_cloud_oci_container_engine_shape_memory_options_tbl,
  network_bandwidth_options dbms_cloud_oci_container_engine_shape_network_bandwidth_options_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_shape_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_shape_t (
    name varchar2,
    processor_description varchar2,
    ocpu_options dbms_cloud_oci_container_engine_shape_ocpu_options_tbl,
    memory_options dbms_cloud_oci_container_engine_shape_memory_options_tbl,
    network_bandwidth_options dbms_cloud_oci_container_engine_shape_network_bandwidth_options_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the identifying shape.

processor_description

(optional) A short description of the VM's processor (CPU).

ocpu_options

(optional) Options for OCPU shape.

memory_options

(optional) ShapeMemoryOptions.

network_bandwidth_options

(optional) ShapeNetworkBandwidthOptions.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_POD_SHAPE_SUMMARY_T Type

Pod shape.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_pod_shape_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  processor_description varchar2(32767),
  ocpu_options dbms_cloud_oci_container_engine_shape_ocpu_options_tbl,
  memory_options dbms_cloud_oci_container_engine_shape_memory_options_tbl,
  network_bandwidth_options dbms_cloud_oci_container_engine_shape_network_bandwidth_options_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_shape_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_pod_shape_summary_t (
    name varchar2,
    processor_description varchar2,
    ocpu_options dbms_cloud_oci_container_engine_shape_ocpu_options_tbl,
    memory_options dbms_cloud_oci_container_engine_shape_memory_options_tbl,
    network_bandwidth_options dbms_cloud_oci_container_engine_shape_network_bandwidth_options_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The name of the identifying shape.

processor_description

(optional) A short description of the VM's processor (CPU).

ocpu_options

(optional) Options for OCPU shape.

memory_options

(optional) ShapeMemoryOptions.

network_bandwidth_options

(optional) ShapeNetworkBandwidthOptions.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_START_CREDENTIAL_ROTATION_DETAILS_T Type

Properties that define a request to start credential rotation on a kubernetes cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_start_credential_rotation_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  auto_completion_delay_duration varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_start_credential_rotation_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_start_credential_rotation_details_t (
    auto_completion_delay_duration varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

auto_completion_delay_duration

(required) The duration in days(in ISO 8601 notation eg. P5D) after which the old credentials should be retired. Maximum delay duration is 14 days.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_TERMINATE_PREEMPTION_ACTION_T Type

Terminates the preemptible instance when it is interrupted for eviction.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_terminate_preemption_action_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_container_engine_preemption_action_t (
  is_preserve_boot_volume number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_terminate_preemption_action_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_terminate_preemption_action_t (
    l_type varchar2,
    is_preserve_boot_volume number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_container_engine_terminate_preemption_action_t is a subtype of the dbms_cloud_oci_container_engine_preemption_action_t type.

Fields

Field Description

is_preserve_boot_volume

(optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_ADDON_DETAILS_T Type

The properties that define to update addon details.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_addon_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  configurations dbms_cloud_oci_container_engine_addon_configuration_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_addon_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_addon_details_t (
    version varchar2,
    configurations dbms_cloud_oci_container_engine_addon_configuration_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(optional) The version of the installed addon.

configurations

(optional) Addon configuration details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_CLUSTER_OPTIONS_DETAILS_T Type

The properties that define extra options updating a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_cluster_options_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  admission_controller_options dbms_cloud_oci_container_engine_admission_controller_options_t,
  persistent_volume_config dbms_cloud_oci_container_engine_persistent_volume_config_details_t,
  service_lb_config dbms_cloud_oci_container_engine_service_lb_config_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_options_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_options_details_t (
    admission_controller_options dbms_cloud_oci_container_engine_admission_controller_options_t,
    persistent_volume_config dbms_cloud_oci_container_engine_persistent_volume_config_details_t,
    service_lb_config dbms_cloud_oci_container_engine_service_lb_config_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

admission_controller_options

(optional) Configurable cluster admission controllers

persistent_volume_config

(optional)

service_lb_config

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_IMAGE_POLICY_CONFIG_DETAILS_T Type

The properties that define a image verification policy.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_image_policy_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_policy_enabled number,
  key_details dbms_cloud_oci_container_engine_key_details_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_image_policy_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_image_policy_config_details_t (
    is_policy_enabled number,
    key_details dbms_cloud_oci_container_engine_key_details_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_policy_enabled

(optional) 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

(optional) A list of KMS key details.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_CLUSTER_DETAILS_T Type

The properties that define a request to update a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_cluster_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  options dbms_cloud_oci_container_engine_update_cluster_options_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  image_policy_config dbms_cloud_oci_container_engine_update_image_policy_config_details_t,
  l_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_details_t (
    name varchar2,
    kubernetes_version varchar2,
    options dbms_cloud_oci_container_engine_update_cluster_options_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    image_policy_config dbms_cloud_oci_container_engine_update_image_policy_config_details_t,
    l_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The new name for the cluster. Avoid entering confidential information.

kubernetes_version

(optional) The version of Kubernetes to which the cluster masters should be upgraded.

options

(optional)

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

image_policy_config

(optional) The image verification policy for signature validation. Once a policy is created and enabled with one or more kms keys, the policy will ensure all images deployed has been signed with the key(s) attached to the policy.

l_type

(optional) Type of cluster

Allowed values are: 'BASIC_CLUSTER', 'ENHANCED_CLUSTER'

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_CLUSTER_ENDPOINT_CONFIG_DETAILS_T Type

The properties that define a request to update a cluster endpoint config.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_cluster_endpoint_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  is_public_ip_enabled number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_endpoint_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_cluster_endpoint_config_details_t (
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    is_public_ip_enabled number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

nsg_ids

(optional) A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

is_public_ip_enabled

(optional) Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster update will fail.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_NODE_POOL_NODE_CONFIG_DETAILS_T Type

The size and placement configuration of nodes in the node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_node_pool_node_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_size number,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  kms_key_id varchar2(32767),
  is_pv_encryption_in_transit_enabled number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
  node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_pool_node_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_pool_node_config_details_t (
    l_size number,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    kms_key_id varchar2,
    is_pv_encryption_in_transit_enabled number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    placement_configs dbms_cloud_oci_container_engine_node_pool_placement_config_details_tbl,
    node_pool_pod_network_option_details dbms_cloud_oci_container_engine_node_pool_pod_network_option_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_size

(optional) The number of nodes in the node pool.

nsg_ids

(optional) The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NETWORK_SECURITY_GROUP Type.

kms_key_id

(optional) The OCID of the Key Management Service key assigned to the boot volume.

is_pv_encryption_in_transit_enabled

(optional) Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

placement_configs

(optional) The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.

node_pool_pod_network_option_details

(optional) The CNI related configuration of pods in the node pool.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_NODE_SHAPE_CONFIG_DETAILS_T Type

The shape configuration of the nodes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_node_shape_config_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  ocpus number,
  memory_in_g_bs number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_shape_config_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_shape_config_details_t (
    ocpus number,
    memory_in_g_bs number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

ocpus

(optional) The total number of OCPUs available to each node in the node pool. See here for details.

memory_in_g_bs

(optional) The total amount of memory available to each node, in gigabytes.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_NODE_POOL_DETAILS_T Type

The properties that define a request to update a node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_node_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  kubernetes_version varchar2(32767),
  initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
  quantity_per_subnet number,
  subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  node_config_details dbms_cloud_oci_container_engine_update_node_pool_node_config_details_t,
  node_metadata json_element_t,
  node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
  ssh_public_key varchar2(32767),
  node_shape varchar2(32767),
  node_shape_config dbms_cloud_oci_container_engine_update_node_shape_config_details_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
  node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_node_pool_details_t (
    name varchar2,
    kubernetes_version varchar2,
    initial_node_labels dbms_cloud_oci_container_engine_key_value_tbl,
    quantity_per_subnet number,
    subnet_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    node_config_details dbms_cloud_oci_container_engine_update_node_pool_node_config_details_t,
    node_metadata json_element_t,
    node_source_details dbms_cloud_oci_container_engine_node_source_details_t,
    ssh_public_key varchar2,
    node_shape varchar2,
    node_shape_config dbms_cloud_oci_container_engine_update_node_shape_config_details_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    node_eviction_node_pool_settings dbms_cloud_oci_container_engine_node_eviction_node_pool_settings_t,
    node_pool_cycling_details dbms_cloud_oci_container_engine_node_pool_cycling_details_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The new name for the cluster. Avoid entering confidential information.

kubernetes_version

(optional) The version of Kubernetes to which the nodes in the node pool should be upgraded.

initial_node_labels

(optional) A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

quantity_per_subnet

(optional) The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated, use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails.

subnet_ids

(optional) The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated, use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified.

node_config_details

(optional) The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails, you must first scale the node pool to 0 nodes using quantityPerSubnet.

node_metadata

(optional) A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

node_source_details

(optional) Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

ssh_public_key

(optional) The SSH public key to add to each node in the node pool on launch.

node_shape

(optional) The name of the node shape of the nodes in the node pool used on launch.

node_shape_config

(optional) Specify the configuration of the shape to launch nodes in the node pool.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

node_eviction_node_pool_settings

(optional)

node_pool_cycling_details

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_VIRTUAL_NODE_POOL_DETAILS_T Type

The properties that define a request to update a virtual node pool.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_virtual_node_pool_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
  taints dbms_cloud_oci_container_engine_taint_tbl,
  l_size number,
  placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_virtual_node_pool_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_virtual_node_pool_details_t (
    display_name varchar2,
    initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
    taints dbms_cloud_oci_container_engine_taint_tbl,
    l_size number,
    placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) Display name of the virtual node pool. This is a non-unique value.

initial_virtual_node_labels

(optional) Initial labels that will be added to the Kubernetes Virtual Node object when it registers.

taints

(optional) A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.

l_size

(optional) The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

placement_configurations

(optional) The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations

nsg_ids

(optional) List of network security group id's applied to the Virtual Node VNIC.

pod_configuration

(optional) The pod configuration for pods run on virtual nodes of this virtual node pool.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

virtual_node_tags

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_UPDATE_WORKLOAD_MAPPING_DETAILS_T Type

The properties that define a workloadMapping

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_update_workload_mapping_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  mapped_compartment_id varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_workload_mapping_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_update_workload_mapping_details_t (
    mapped_compartment_id varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

mapped_compartment_id

(optional) The OCID of the mapped customer compartment.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VIRTUAL_NODE_T Type

The properties that define a virtual node.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_virtual_node_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  kubernetes_version varchar2(32767),
  virtual_node_pool_id varchar2(32767),
  availability_domain varchar2(32767),
  fault_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  private_ip varchar2(32767),
  virtual_node_error varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_t (
    id varchar2,
    display_name varchar2,
    kubernetes_version varchar2,
    virtual_node_pool_id varchar2,
    availability_domain varchar2,
    fault_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    private_ip varchar2,
    virtual_node_error varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The ocid of the virtual node.

display_name

(required) The name of the virtual node.

kubernetes_version

(optional) The version of Kubernetes this virtual node is running.

virtual_node_pool_id

(required) The ocid of the virtual node pool this virtual node belongs to.

availability_domain

(optional) The name of the availability domain in which this virtual node is placed

fault_domain

(optional) The fault domain of this virtual node.

subnet_id

(optional) The OCID of the subnet in which this Virtual Node is placed.

nsg_ids

(optional) NSG Ids applied to virtual node vnic.

private_ip

(optional) The private IP address of this Virtual Node.

virtual_node_error

(optional) An error that may be associated with the virtual node.

lifecycle_state

(optional) The state of the Virtual Node.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the Virtual Node.

time_created

(optional) The time at which the virtual node was created.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VIRTUAL_NODE_POOL_T Type

A pool of virtual nodes attached to a cluster.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_virtual_node_pool_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  display_name varchar2(32767),
  kubernetes_version varchar2(32767),
  initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
  taints dbms_cloud_oci_container_engine_taint_tbl,
  l_size number,
  placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_pool_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_pool_t (
    id varchar2,
    compartment_id varchar2,
    cluster_id varchar2,
    display_name varchar2,
    kubernetes_version varchar2,
    initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
    taints dbms_cloud_oci_container_engine_taint_tbl,
    l_size number,
    placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the virtual node pool.

compartment_id

(required) Compartment of the virtual node pool.

cluster_id

(required) The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

display_name

(required) Display name of the virtual node pool. This is a non-unique value.

kubernetes_version

(required) The version of Kubernetes running on the nodes in the node pool.

initial_virtual_node_labels

(optional) Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.

taints

(optional) A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.

l_size

(optional) The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

placement_configurations

(required) The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations

nsg_ids

(optional) List of network security group id's applied to the Virtual Node VNIC.

pod_configuration

(optional) The pod configuration for pods run on virtual nodes of this virtual node pool.

lifecycle_state

(optional) The state of the Virtual Node Pool.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the Virtual Node Pool.

time_created

(optional) The time the virtual node pool was created.

time_updated

(optional) The time the virtual node pool was updated.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

virtual_node_tags

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VIRTUAL_NODE_POOL_SUMMARY_T Type

The properties that define a virtual node pool summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_virtual_node_pool_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  cluster_id varchar2(32767),
  display_name varchar2(32767),
  kubernetes_version varchar2(32767),
  initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
  taints dbms_cloud_oci_container_engine_taint_tbl,
  l_size number,
  placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_pool_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_pool_summary_t (
    id varchar2,
    compartment_id varchar2,
    cluster_id varchar2,
    display_name varchar2,
    kubernetes_version varchar2,
    initial_virtual_node_labels dbms_cloud_oci_container_engine_initial_virtual_node_label_tbl,
    taints dbms_cloud_oci_container_engine_taint_tbl,
    l_size number,
    placement_configurations dbms_cloud_oci_container_engine_placement_configuration_tbl,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    pod_configuration dbms_cloud_oci_container_engine_pod_configuration_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    virtual_node_tags dbms_cloud_oci_container_engine_virtual_node_tags_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The OCID of the virtual node pool.

compartment_id

(required) Compartment of the virtual node pool.

cluster_id

(required) The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

display_name

(required) Display name of the virtual node pool. This is a non-unique value.

kubernetes_version

(required) The version of Kubernetes running on the nodes in the node pool.

initial_virtual_node_labels

(optional) Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.

taints

(optional) A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.

l_size

(optional) The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

placement_configurations

(required) The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations

nsg_ids

(optional) List of network security group id's applied to the Virtual Node VNIC.

pod_configuration

(optional) The pod configuration for pods run on virtual nodes of this virtual node pool.

lifecycle_state

(optional) The state of the Virtual Node Pool.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the Virtual Node Pool.

time_created

(optional) The time the virtual node pool was created.

time_updated

(optional) The time the virtual node pool was updated.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

virtual_node_tags

(optional)

DBMS_CLOUD_OCI_CONTAINER_ENGINE_VIRTUAL_NODE_SUMMARY_T Type

The properties that define a virtual node summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_virtual_node_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  kubernetes_version varchar2(32767),
  virtual_node_pool_id varchar2(32767),
  availability_domain varchar2(32767),
  fault_domain varchar2(32767),
  subnet_id varchar2(32767),
  nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
  private_ip varchar2(32767),
  virtual_node_error varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  time_created timestamp with time zone,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_virtual_node_summary_t (
    id varchar2,
    display_name varchar2,
    kubernetes_version varchar2,
    virtual_node_pool_id varchar2,
    availability_domain varchar2,
    fault_domain varchar2,
    subnet_id varchar2,
    nsg_ids dbms_cloud_oci_container_engine_varchar2_tbl,
    private_ip varchar2,
    virtual_node_error varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    time_created timestamp with time zone,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The ocid of the virtual node.

display_name

(required) The name of the virtual node.

kubernetes_version

(optional) The version of Kubernetes this virtual node is running.

virtual_node_pool_id

(required) The ocid of the virtual node pool this virtual node belongs to.

availability_domain

(optional) The name of the availability domain in which this virtual node is placed

fault_domain

(optional) The fault domain of this virtual node.

subnet_id

(optional) The OCID of the subnet in which this Virtual Node is placed.

nsg_ids

(optional) NSG Ids applied to virtual node vnic.

private_ip

(optional) The private IP address of this Virtual Node.

virtual_node_error

(optional) An error that may be associated with the virtual node.

lifecycle_state

(optional) The state of the Virtual Node.

Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'

lifecycle_details

(optional) Details about the state of the Virtual Node.

time_created

(optional) The time at which the virtual node was created.

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_RESOURCE_T Type

The properties that define a work request resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  action_type varchar2(32767),
  entity_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_resource_t (
    action_type varchar2,
    entity_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

action_type

(optional) The way in which this resource was affected by the work tracked by the work request.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'RELATED', 'IN_PROGRESS', 'FAILED', 'CANCELED_CREATE', 'CANCELED_UPDATE', 'CANCELED_DELETE'

entity_type

(optional) The resource type the work request affects.

identifier

(optional) The OCID of the resource the work request affects.

entity_uri

(optional) The URI path on which the user can issue a GET request to access the resource metadata.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_container_engine_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_container_engine_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_T Type

An asynchronous work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  operation_type varchar2(32767),
  status varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_container_engine_work_request_resource_tbl,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_t (
    id varchar2,
    operation_type varchar2,
    status varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_container_engine_work_request_resource_tbl,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the work request.

operation_type

(optional) The type of work the work request is doing.

Allowed values are: 'CLUSTER_CREATE', 'CLUSTER_UPDATE', 'CLUSTER_DELETE', 'NODEPOOL_CREATE', 'NODEPOOL_UPDATE', 'NODEPOOL_DELETE', 'NODEPOOL_RECONCILE', 'NODEPOOL_CYCLING', 'WORKREQUEST_CANCEL', 'VIRTUALNODEPOOL_CREATE', 'VIRTUALNODEPOOL_UPDATE', 'VIRTUALNODEPOOL_DELETE', 'VIRTUALNODE_DELETE', 'ENABLE_ADDON', 'UPDATE_ADDON', 'DISABLE_ADDON', 'RECONCILE_ADDON'

status

(optional) The current status of the work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

compartment_id

(optional) The OCID of the compartment in which the work request exists.

resources

(optional) The resources this work request affects.

time_accepted

(optional) The time the work request was accepted.

time_started

(optional) The time the work request was started.

time_finished

(optional) The time the work request was finished.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_ERROR_T Type

Errors related to a specific work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

l_timestamp

(required) The date and time the error occurred.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_LOG_ENTRY_T Type

Log entries related to a specific work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_log_entry_t (
    message varchar2,
    l_timestamp varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(optional) The description of an action that occurred.

l_timestamp

(optional) The date and time the log entry occurred.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORK_REQUEST_SUMMARY_T Type

The properties that define a work request summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  operation_type varchar2(32767),
  status varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_container_engine_work_request_resource_tbl,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_work_request_summary_t (
    id varchar2,
    operation_type varchar2,
    status varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_container_engine_work_request_resource_tbl,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(optional) The OCID of the work request.

operation_type

(optional) The type of work the work request is doing.

Allowed values are: 'CLUSTER_CREATE', 'CLUSTER_UPDATE', 'CLUSTER_DELETE', 'NODEPOOL_CREATE', 'NODEPOOL_UPDATE', 'NODEPOOL_DELETE', 'NODEPOOL_RECONCILE', 'NODEPOOL_CYCLING', 'WORKREQUEST_CANCEL', 'VIRTUALNODEPOOL_CREATE', 'VIRTUALNODEPOOL_UPDATE', 'VIRTUALNODEPOOL_DELETE', 'VIRTUALNODE_DELETE', 'ENABLE_ADDON', 'UPDATE_ADDON', 'DISABLE_ADDON', 'RECONCILE_ADDON'

status

(optional) The current status of the work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

compartment_id

(optional) The OCID of the compartment in which the work request exists.

resources

(optional) The resources this work request affects.

time_accepted

(optional) The time the work request was accepted.

time_started

(optional) The time the work request was started.

time_finished

(optional) The time the work request was finished.

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORKLOAD_MAPPING_T Type

The properties that define an workloadMapping.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_workload_mapping_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  cluster_id varchar2(32767),
  namespace varchar2(32767),
  mapped_tenancy_id varchar2(32767),
  mapped_compartment_id varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_workload_mapping_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_workload_mapping_t (
    id varchar2,
    cluster_id varchar2,
    namespace varchar2,
    mapped_tenancy_id varchar2,
    mapped_compartment_id varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The ocid of the workloadMapping.

cluster_id

(required) The OCID of the cluster.

namespace

(required) The namespace of the workloadMapping.

mapped_tenancy_id

(required) The OCID of the mapped customer tenancy.

mapped_compartment_id

(required) The OCID of the mapped customer compartment.

time_created

(required) The time the cluster was created.

lifecycle_state

(required) The state of the workloadMapping.

Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

DBMS_CLOUD_OCI_CONTAINER_ENGINE_WORKLOAD_MAPPING_SUMMARY_T Type

The properties that define an workloadMapping summary.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_container_engine_workload_mapping_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  cluster_id varchar2(32767),
  namespace varchar2(32767),
  mapped_tenancy_id varchar2(32767),
  mapped_compartment_id varchar2(32767),
  time_created timestamp with time zone,
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_workload_mapping_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_container_engine_workload_mapping_summary_t (
    id varchar2,
    cluster_id varchar2,
    namespace varchar2,
    mapped_tenancy_id varchar2,
    mapped_compartment_id varchar2,
    time_created timestamp with time zone,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The ocid of the workloadMapping.

cluster_id

(required) The OCID of the cluster.

namespace

(required) The namespace of the workloadMapping.

mapped_tenancy_id

(required) The OCID of the mapped customer tenancy.

mapped_compartment_id

(required) The OCID of the mapped customer compartment.

time_created

(required) The time the cluster was created.

lifecycle_state

(required) The state of the workloadMapping.

Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'

freeform_tags

(optional) 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

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

Was this article helpful?