clusters

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

Overview

Name	clusters
Type	Resource
Id	google.vmwareengine.clusters

Fields

Name	Datatype	Description
name	string	Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster
autoscalingSettings	object	Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.
createTime	string	Output only. Creation time of this resource.
management	boolean	Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.
nodeTypeConfigs	object	Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).
state	string	Output only. State of the resource.
stretchedClusterConfig	object	Configuration of a stretched cluster.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string	Output only. Last update time of this resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clustersId, locationsId, privateCloudsId, projectsId	Retrieves a Cluster resource by its resource name.
list	SELECT	locationsId, privateCloudsId, projectsId	Lists Cluster resources in a given private cloud.
create	INSERT	locationsId, privateCloudsId, projectsId	Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.
delete	DELETE	clustersId, locationsId, privateCloudsId, projectsId	Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.
patch	UPDATE	clustersId, locationsId, privateCloudsId, projectsId	Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

SELECT examples

Lists Cluster resources in a given private cloud.

SELECT
name,
autoscalingSettings,
createTime,
management,
nodeTypeConfigs,
state,
stretchedClusterConfig,
uid,
updateTime
FROM google.vmwareengine.clusters
WHERE locationsId = '{{ locationsId }}'
AND privateCloudsId = '{{ privateCloudsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO google.vmwareengine.clusters (
locationsId,
privateCloudsId,
projectsId,
autoscalingSettings,
nodeTypeConfigs,
stretchedClusterConfig
)
SELECT 
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ projectsId }}',
'{{ autoscalingSettings }}',
'{{ nodeTypeConfigs }}',
'{{ stretchedClusterConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: management
      value: boolean
    - name: autoscalingSettings
      value:
        - name: autoscalingPolicies
          value: object
        - name: minClusterNodeCount
          value: integer
        - name: maxClusterNodeCount
          value: integer
        - name: coolDownPeriod
          value: string
    - name: uid
      value: string
    - name: nodeTypeConfigs
      value: object
    - name: stretchedClusterConfig
      value:
        - name: preferredLocation
          value: string
        - name: secondaryLocation
          value: string

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE google.vmwareengine.clusters
SET 
autoscalingSettings = '{{ autoscalingSettings }}',
nodeTypeConfigs = '{{ nodeTypeConfigs }}',
stretchedClusterConfig = '{{ stretchedClusterConfig }}'
WHERE 
clustersId = '{{ clustersId }}'
AND locationsId = '{{ locationsId }}'
AND privateCloudsId = '{{ privateCloudsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM google.vmwareengine.clusters
WHERE clustersId = '{{ clustersId }}'
AND locationsId = '{{ locationsId }}'
AND privateCloudsId = '{{ privateCloudsId }}'
AND projectsId = '{{ projectsId }}';