Skip to main content

memberships

Overview

Namememberships
TypeResource
Idgoogle.gkehub.memberships

Fields

NameDatatypeDescription
namestringOutput only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/{membership_id}, set during creation. membership_id must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or - 3. It must start and end with an alphanumeric character Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
descriptionstringOutput only. Description of this membership, limited to 63 characters. Must match the regex: a-zA-Z0-9* This field is present for legacy purposes.
authorityobjectAuthority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
createTimestringOutput only. When the Membership was created.
deleteTimestringOutput only. When the Membership was deleted.
endpointobjectMembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
externalIdstringOptional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: a-zA-Z0-9* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object.
labelsobjectOptional. Labels for this membership.
lastConnectionTimestringOutput only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.
monitoringConfigobjectThis field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.
stateobjectMembershipState describes the state of a Membership resource.
uniqueIdstringOutput only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.
updateTimestringOutput only. When the Membership was last updated.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_memberships_getSELECTlocationsId, membershipsId, projectsIdGets the details of a Membership.
projects_locations_memberships_listSELECTlocationsId, projectsIdLists Memberships in a given project and location.
projects_locations_memberships_createINSERTlocationsId, projectsIdCreates a new Membership. This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
projects_locations_memberships_deleteDELETElocationsId, membershipsId, projectsIdRemoves a Membership. This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
_projects_locations_memberships_listEXEClocationsId, projectsIdLists Memberships in a given project and location.
projects_locations_memberships_generate_connect_manifestEXEClocationsId, membershipsId, projectsIdGenerates the manifest for deployment of the GKE connect agent. This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.
projects_locations_memberships_patchEXEClocationsId, membershipsId, projectsIdUpdates an existing Membership.