Clusters.Update | Workflows

func (*ClusterClient) Update(
    ctx context.Context,
    slug string,
    options ...cluster.UpdateOption,
) (*workflows.Cluster, error)

Update a cluster.

Parameters

slug string

The slug of the cluster to update.

cluster.WithName(name string) cluster.UpdateOption

Optional new display name for the cluster.

cluster.WithDescription(description string) cluster.UpdateOption

Optional new cluster description. Pass an empty string to clear the description.

The updated cluster object, including its slug, name, description, whether it can be deleted, and deployed workflows.

not_found cluster not found

The specified cluster does not exist.