Interface EnforcePolicyComplianceForClusterRequest

interface EnforcePolicyComplianceForClusterRequest {
    clusterId?: string;
    enforceMode?: EnforcePolicyComplianceForClusterRequest_EnforceMode;
    validateOnly?: boolean;
}

Properties

clusterId?: string

The ID of the cluster you want to enforce policy compliance on.

Determines how changes should be made to clusters that are not in TERMINATED state.

ENFORCE_IMMEDIATELY: If the cluster is in a RUNNING state, it will be restarted so that the new attributes can take effect. For other states aside from TERMINATED state, the request will be rejected.
WAIT_FOR_TERMINATION: The cluster is not immediately edited. Instead, a pending enforcement is scheduled to update the cluster when it terminates or restarts. When this occurs, enforce_result will contain DEFERRED. Only workspace admins can use this mode.

Regardless of the enforce mode, clusters in TERMINATED state are immediately edited.

validateOnly?: boolean

If set, previews the changes that would be made to a cluster to enforce compliance but does not update the cluster.