Skip to main content

credential_rotation_status

Creates, updates, deletes, gets or lists a credential_rotation_status resource.

Overview​

Namecredential_rotation_status
TypeResource
Idoci.container_engine.credential_rotation_status

Fields​

The following fields are returned by SELECT queries:

The cluster credential rotation status details.

NameDatatypeDescription
statusstringCredential 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. (IN_PROGRESS, WAITING, COMPLETED)
statusDetailsstringDetails 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. (ISSUING_NEW_CREDENTIALS, NEW_CREDENTIALS_ISSUED, RETIRING_OLD_CREDENTIALS, COMPLETED)
timeAutoCompletionScheduledstring (date-time)The time by which retirement of old credentials should start. (example: 2017-07-21T16:11:29Z)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectclusterId, regionopc-request-idGet cluster credential rotation status.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
clusterIdstringThe OCID of the cluster.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

SELECT examples​

Get cluster credential rotation status.

SELECT
status,
statusDetails,
timeAutoCompletionScheduled
FROM oci.container_engine.credential_rotation_status
WHERE clusterId = '{{ clusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;