Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.gkehub/v1.getMembership
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets the details of a Membership.
Using getMembership
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getMembership(args: GetMembershipArgs, opts?: InvokeOptions): Promise<GetMembershipResult>
function getMembershipOutput(args: GetMembershipOutputArgs, opts?: InvokeOptions): Output<GetMembershipResult>
def get_membership(location: Optional[str] = None,
membership_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMembershipResult
def get_membership_output(location: Optional[pulumi.Input[str]] = None,
membership_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMembershipResult]
func LookupMembership(ctx *Context, args *LookupMembershipArgs, opts ...InvokeOption) (*LookupMembershipResult, error)
func LookupMembershipOutput(ctx *Context, args *LookupMembershipOutputArgs, opts ...InvokeOption) LookupMembershipResultOutput
> Note: This function is named LookupMembership
in the Go SDK.
public static class GetMembership
{
public static Task<GetMembershipResult> InvokeAsync(GetMembershipArgs args, InvokeOptions? opts = null)
public static Output<GetMembershipResult> Invoke(GetMembershipInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMembershipResult> getMembership(GetMembershipArgs args, InvokeOptions options)
public static Output<GetMembershipResult> getMembership(GetMembershipArgs args, InvokeOptions options)
fn::invoke:
function: google-native:gkehub/v1:getMembership
arguments:
# arguments dictionary
The following arguments are supported:
- Location
This property is required. string - Membership
Id This property is required. string - Project string
- Location
This property is required. string - Membership
Id This property is required. string - Project string
- location
This property is required. String - membership
Id This property is required. String - project String
- location
This property is required. string - membership
Id This property is required. string - project string
- location
This property is required. str - membership_
id This property is required. str - project str
- location
This property is required. String - membership
Id This property is required. String - project String
getMembership Result
The following output properties are available:
- Pulumi.
Google Native. GKEHub. V1. Outputs. Authority Response - Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- Create
Time string - When the Membership was created.
- Delete
Time string - When the Membership was deleted.
- Description string
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - Endpoint
Pulumi.
Google Native. GKEHub. V1. Outputs. Membership Endpoint Response - Optional. Endpoint information to reach this member.
- External
Id string - Optional. 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 thekube-system
namespace object. - Labels Dictionary<string, string>
- Optional. Labels for this membership.
- Last
Connection stringTime - 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.
- Monitoring
Config Pulumi.Google Native. GKEHub. V1. Outputs. Monitoring Config Response - Optional. The monitoring config information for this membership.
- Name string
- 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. - State
Pulumi.
Google Native. GKEHub. V1. Outputs. Membership State Response - State of the Membership resource.
- Unique
Id string - 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.
- Update
Time string - When the Membership was last updated.
- Authority
Response - Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- Create
Time string - When the Membership was created.
- Delete
Time string - When the Membership was deleted.
- Description string
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - Endpoint
Membership
Endpoint Response - Optional. Endpoint information to reach this member.
- External
Id string - Optional. 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 thekube-system
namespace object. - Labels map[string]string
- Optional. Labels for this membership.
- Last
Connection stringTime - 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.
- Monitoring
Config MonitoringConfig Response - Optional. The monitoring config information for this membership.
- Name string
- 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. - State
Membership
State Response - State of the Membership resource.
- Unique
Id string - 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.
- Update
Time string - When the Membership was last updated.
- Authority
Response - Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- create
Time String - When the Membership was created.
- delete
Time String - When the Membership was deleted.
- description String
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - endpoint
Membership
Endpoint Response - Optional. Endpoint information to reach this member.
- external
Id String - Optional. 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 thekube-system
namespace object. - labels Map<String,String>
- Optional. Labels for this membership.
- last
Connection StringTime - 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.
- monitoring
Config MonitoringConfig Response - Optional. The monitoring config information for this membership.
- name String
- 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. - state
Membership
State Response - State of the Membership resource.
- unique
Id String - 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.
- update
Time String - When the Membership was last updated.
- Authority
Response - Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- create
Time string - When the Membership was created.
- delete
Time string - When the Membership was deleted.
- description string
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - endpoint
Membership
Endpoint Response - Optional. Endpoint information to reach this member.
- external
Id string - Optional. 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 thekube-system
namespace object. - labels {[key: string]: string}
- Optional. Labels for this membership.
- last
Connection stringTime - 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.
- monitoring
Config MonitoringConfig Response - Optional. The monitoring config information for this membership.
- name string
- 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. - state
Membership
State Response - State of the Membership resource.
- unique
Id string - 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.
- update
Time string - When the Membership was last updated.
- Authority
Response - Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- create_
time str - When the Membership was created.
- delete_
time str - When the Membership was deleted.
- description str
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - endpoint
Membership
Endpoint Response - Optional. Endpoint information to reach this member.
- external_
id str - Optional. 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 thekube-system
namespace object. - labels Mapping[str, str]
- Optional. Labels for this membership.
- last_
connection_ strtime - 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.
- monitoring_
config MonitoringConfig Response - Optional. The monitoring config information for this membership.
- name str
- 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. - state
Membership
State Response - State of the Membership resource.
- unique_
id str - 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.
- update_
time str - When the Membership was last updated.
- Property Map
- Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
- create
Time String - When the Membership was created.
- delete
Time String - When the Membership was deleted.
- description String
- Description of this membership, limited to 63 characters. Must match the regex:
a-zA-Z0-9*
This field is present for legacy purposes. - endpoint Property Map
- Optional. Endpoint information to reach this member.
- external
Id String - Optional. 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 thekube-system
namespace object. - labels Map<String>
- Optional. Labels for this membership.
- last
Connection StringTime - 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.
- monitoring
Config Property Map - Optional. The monitoring config information for this membership.
- name String
- 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. - state Property Map
- State of the Membership resource.
- unique
Id String - 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.
- update
Time String - When the Membership was last updated.
Supporting Types
ApplianceClusterResponse
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
- resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
- resource_
link This property is required. str - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance
AuthorityResponse
- Identity
Provider This property is required. string - An identity provider that reflects the
issuer
in the workload identity pool. - Issuer
This property is required. string - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - Oidc
Jwks This property is required. string - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - Workload
Identity Pool This property is required. string - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
- Identity
Provider This property is required. string - An identity provider that reflects the
issuer
in the workload identity pool. - Issuer
This property is required. string - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - Oidc
Jwks This property is required. string - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - Workload
Identity Pool This property is required. string - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
- identity
Provider This property is required. String - An identity provider that reflects the
issuer
in the workload identity pool. - issuer
This property is required. String - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - oidc
Jwks This property is required. String - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - workload
Identity Pool This property is required. String - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
- identity
Provider This property is required. string - An identity provider that reflects the
issuer
in the workload identity pool. - issuer
This property is required. string - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - oidc
Jwks This property is required. string - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - workload
Identity Pool This property is required. string - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
- identity_
provider This property is required. str - An identity provider that reflects the
issuer
in the workload identity pool. - issuer
This property is required. str - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - oidc_
jwks This property is required. str - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - workload_
identity_ pool This property is required. str - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
- identity
Provider This property is required. String - An identity provider that reflects the
issuer
in the workload identity pool. - issuer
This property is required. String - Optional. A JSON Web Token (JWT) issuer URI.
issuer
must start withhttps://
and be a valid URL with length <2000 characters, it must uselocation
rather thanzone
for GKE clusters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearingissuer
disables Workload Identity.issuer
cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity). - oidc
Jwks This property is required. String - Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on
issuer
, and instead OIDC tokens will be validated using this field. - workload
Identity Pool This property is required. String - The name of the workload identity pool in which
issuer
will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is{PROJECT_ID}.hub.id.goog
, although this is subject to change in newer versions of this API.
EdgeClusterResponse
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
- resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
- resource_
link This property is required. str - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster
GkeClusterResponse
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
- cluster
Missing This property is required. boolean - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
- cluster_
missing This property is required. bool - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- resource_
link This property is required. str - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.
KubernetesMetadataResponse
- Kubernetes
Api Server Version This property is required. string - Kubernetes API server version string as reported by
/version
. - Memory
Mb This property is required. int - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- Node
Count This property is required. int - Node count as reported by Kubernetes nodes resources.
- Node
Provider Id This property is required. string - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- Update
Time This property is required. string - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- Vcpu
Count This property is required. int - vCPU count as reported by Kubernetes nodes resources.
- Kubernetes
Api Server Version This property is required. string - Kubernetes API server version string as reported by
/version
. - Memory
Mb This property is required. int - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- Node
Count This property is required. int - Node count as reported by Kubernetes nodes resources.
- Node
Provider Id This property is required. string - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- Update
Time This property is required. string - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- Vcpu
Count This property is required. int - vCPU count as reported by Kubernetes nodes resources.
- kubernetes
Api Server Version This property is required. String - Kubernetes API server version string as reported by
/version
. - memory
Mb This property is required. Integer - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- node
Count This property is required. Integer - Node count as reported by Kubernetes nodes resources.
- node
Provider Id This property is required. String - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- update
Time This property is required. String - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- vcpu
Count This property is required. Integer - vCPU count as reported by Kubernetes nodes resources.
- kubernetes
Api Server Version This property is required. string - Kubernetes API server version string as reported by
/version
. - memory
Mb This property is required. number - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- node
Count This property is required. number - Node count as reported by Kubernetes nodes resources.
- node
Provider Id This property is required. string - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- update
Time This property is required. string - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- vcpu
Count This property is required. number - vCPU count as reported by Kubernetes nodes resources.
- kubernetes_
api_ server_ version This property is required. str - Kubernetes API server version string as reported by
/version
. - memory_
mb This property is required. int - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- node_
count This property is required. int - Node count as reported by Kubernetes nodes resources.
- node_
provider_ id This property is required. str - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- update_
time This property is required. str - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- vcpu_
count This property is required. int - vCPU count as reported by Kubernetes nodes resources.
- kubernetes
Api Server Version This property is required. String - Kubernetes API server version string as reported by
/version
. - memory
Mb This property is required. Number - The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.
- node
Count This property is required. Number - Node count as reported by Kubernetes nodes resources.
- node
Provider Id This property is required. String - Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.
- update
Time This property is required. String - The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.
- vcpu
Count This property is required. Number - vCPU count as reported by Kubernetes nodes resources.
KubernetesResourceResponse
- Connect
Resources This property is required. List<Pulumi.Google Native. GKEHub. V1. Inputs. Resource Manifest Response> - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- Membership
Cr Manifest This property is required. string - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- Membership
Resources This property is required. List<Pulumi.Google Native. GKEHub. V1. Inputs. Resource Manifest Response> - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- Resource
Options This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Resource Options Response - Optional. Options for Kubernetes resource generation.
- Connect
Resources This property is required. []ResourceManifest Response - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- Membership
Cr Manifest This property is required. string - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- Membership
Resources This property is required. []ResourceManifest Response - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- Resource
Options This property is required. ResourceOptions Response - Optional. Options for Kubernetes resource generation.
- connect
Resources This property is required. List<ResourceManifest Response> - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- membership
Cr Manifest This property is required. String - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- membership
Resources This property is required. List<ResourceManifest Response> - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- resource
Options This property is required. ResourceOptions Response - Optional. Options for Kubernetes resource generation.
- connect
Resources This property is required. ResourceManifest Response[] - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- membership
Cr Manifest This property is required. string - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- membership
Resources This property is required. ResourceManifest Response[] - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- resource
Options This property is required. ResourceOptions Response - Optional. Options for Kubernetes resource generation.
- connect_
resources This property is required. Sequence[ResourceManifest Response] - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- membership_
cr_ manifest This property is required. str - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- membership_
resources This property is required. Sequence[ResourceManifest Response] - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- resource_
options This property is required. ResourceOptions Response - Optional. Options for Kubernetes resource generation.
- connect
Resources This property is required. List<Property Map> - The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- membership
Cr Manifest This property is required. String - Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly. Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.
- membership
Resources This property is required. List<Property Map> - Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.
- resource
Options This property is required. Property Map - Optional. Options for Kubernetes resource generation.
MembershipEndpointResponse
- Appliance
Cluster This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Appliance Cluster Response - Optional. Specific information for a GDC Edge Appliance cluster.
- Edge
Cluster This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Edge Cluster Response - Optional. Specific information for a Google Edge cluster.
- Gke
Cluster This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Gke Cluster Response - Optional. Specific information for a GKE-on-GCP cluster.
- Google
Managed This property is required. bool - Whether the lifecycle of this membership is managed by a google cluster platform service.
- Kubernetes
Metadata This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Kubernetes Metadata Response - Useful Kubernetes-specific metadata.
- Kubernetes
Resource This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Kubernetes Resource Response - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- Multi
Cloud Cluster This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. Multi Cloud Cluster Response - Optional. Specific information for a GKE Multi-Cloud cluster.
- On
Prem Cluster This property is required. Pulumi.Google Native. GKEHub. V1. Inputs. On Prem Cluster Response - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
- Appliance
Cluster This property is required. ApplianceCluster Response - Optional. Specific information for a GDC Edge Appliance cluster.
- Edge
Cluster This property is required. EdgeCluster Response - Optional. Specific information for a Google Edge cluster.
- Gke
Cluster This property is required. GkeCluster Response - Optional. Specific information for a GKE-on-GCP cluster.
- Google
Managed This property is required. bool - Whether the lifecycle of this membership is managed by a google cluster platform service.
- Kubernetes
Metadata This property is required. KubernetesMetadata Response - Useful Kubernetes-specific metadata.
- Kubernetes
Resource This property is required. KubernetesResource Response - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- Multi
Cloud Cluster This property is required. MultiCloud Cluster Response - Optional. Specific information for a GKE Multi-Cloud cluster.
- On
Prem Cluster This property is required. OnPrem Cluster Response - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
- appliance
Cluster This property is required. ApplianceCluster Response - Optional. Specific information for a GDC Edge Appliance cluster.
- edge
Cluster This property is required. EdgeCluster Response - Optional. Specific information for a Google Edge cluster.
- gke
Cluster This property is required. GkeCluster Response - Optional. Specific information for a GKE-on-GCP cluster.
- google
Managed This property is required. Boolean - Whether the lifecycle of this membership is managed by a google cluster platform service.
- kubernetes
Metadata This property is required. KubernetesMetadata Response - Useful Kubernetes-specific metadata.
- kubernetes
Resource This property is required. KubernetesResource Response - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- multi
Cloud Cluster This property is required. MultiCloud Cluster Response - Optional. Specific information for a GKE Multi-Cloud cluster.
- on
Prem Cluster This property is required. OnPrem Cluster Response - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
- appliance
Cluster This property is required. ApplianceCluster Response - Optional. Specific information for a GDC Edge Appliance cluster.
- edge
Cluster This property is required. EdgeCluster Response - Optional. Specific information for a Google Edge cluster.
- gke
Cluster This property is required. GkeCluster Response - Optional. Specific information for a GKE-on-GCP cluster.
- google
Managed This property is required. boolean - Whether the lifecycle of this membership is managed by a google cluster platform service.
- kubernetes
Metadata This property is required. KubernetesMetadata Response - Useful Kubernetes-specific metadata.
- kubernetes
Resource This property is required. KubernetesResource Response - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- multi
Cloud Cluster This property is required. MultiCloud Cluster Response - Optional. Specific information for a GKE Multi-Cloud cluster.
- on
Prem Cluster This property is required. OnPrem Cluster Response - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
- appliance_
cluster This property is required. ApplianceCluster Response - Optional. Specific information for a GDC Edge Appliance cluster.
- edge_
cluster This property is required. EdgeCluster Response - Optional. Specific information for a Google Edge cluster.
- gke_
cluster This property is required. GkeCluster Response - Optional. Specific information for a GKE-on-GCP cluster.
- google_
managed This property is required. bool - Whether the lifecycle of this membership is managed by a google cluster platform service.
- kubernetes_
metadata This property is required. KubernetesMetadata Response - Useful Kubernetes-specific metadata.
- kubernetes_
resource This property is required. KubernetesResource Response - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- multi_
cloud_ cluster This property is required. MultiCloud Cluster Response - Optional. Specific information for a GKE Multi-Cloud cluster.
- on_
prem_ cluster This property is required. OnPrem Cluster Response - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
- appliance
Cluster This property is required. Property Map - Optional. Specific information for a GDC Edge Appliance cluster.
- edge
Cluster This property is required. Property Map - Optional. Specific information for a Google Edge cluster.
- gke
Cluster This property is required. Property Map - Optional. Specific information for a GKE-on-GCP cluster.
- google
Managed This property is required. Boolean - Whether the lifecycle of this membership is managed by a google cluster platform service.
- kubernetes
Metadata This property is required. Property Map - Useful Kubernetes-specific metadata.
- kubernetes
Resource This property is required. Property Map - Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.
- multi
Cloud Cluster This property is required. Property Map - Optional. Specific information for a GKE Multi-Cloud cluster.
- on
Prem Cluster This property is required. Property Map - Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.
MembershipStateResponse
- Code
This property is required. string - The current state of the Membership resource.
- Code
This property is required. string - The current state of the Membership resource.
- code
This property is required. String - The current state of the Membership resource.
- code
This property is required. string - The current state of the Membership resource.
- code
This property is required. str - The current state of the Membership resource.
- code
This property is required. String - The current state of the Membership resource.
MonitoringConfigResponse
- Cluster
This property is required. string - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- Cluster
Hash This property is required. string - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- Kubernetes
Metrics Prefix This property is required. string - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- Location
This property is required. string - Optional. Location used to report Metrics
- Project
This property is required. string - Optional. Project used to report Metrics
- Cluster
This property is required. string - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- Cluster
Hash This property is required. string - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- Kubernetes
Metrics Prefix This property is required. string - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- Location
This property is required. string - Optional. Location used to report Metrics
- Project
This property is required. string - Optional. Project used to report Metrics
- cluster
This property is required. String - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- cluster
Hash This property is required. String - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- kubernetes
Metrics Prefix This property is required. String - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- location
This property is required. String - Optional. Location used to report Metrics
- project
This property is required. String - Optional. Project used to report Metrics
- cluster
This property is required. string - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- cluster
Hash This property is required. string - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- kubernetes
Metrics Prefix This property is required. string - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- location
This property is required. string - Optional. Location used to report Metrics
- project
This property is required. string - Optional. Project used to report Metrics
- cluster
This property is required. str - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- cluster_
hash This property is required. str - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- kubernetes_
metrics_ prefix This property is required. str - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- location
This property is required. str - Optional. Location used to report Metrics
- project
This property is required. str - Optional. Project used to report Metrics
- cluster
This property is required. String - Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1".
- cluster
Hash This property is required. String - Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID.
- kubernetes
Metrics Prefix This property is required. String - Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos.
- location
This property is required. String - Optional. Location used to report Metrics
- project
This property is required. String - Optional. Project used to report Metrics
MultiCloudClusterResponse
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
- cluster
Missing This property is required. boolean - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
- cluster_
missing This property is required. bool - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- resource_
link This property is required. str - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster
OnPremClusterResponse
- Admin
Cluster This property is required. bool - Immutable. Whether the cluster is an admin cluster.
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- Cluster
Type This property is required. string - Immutable. The on prem cluster's type.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
- Admin
Cluster This property is required. bool - Immutable. Whether the cluster is an admin cluster.
- Cluster
Missing This property is required. bool - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- Cluster
Type This property is required. string - Immutable. The on prem cluster's type.
- Resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
- admin
Cluster This property is required. Boolean - Immutable. Whether the cluster is an admin cluster.
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- cluster
Type This property is required. String - Immutable. The on prem cluster's type.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
- admin
Cluster This property is required. boolean - Immutable. Whether the cluster is an admin cluster.
- cluster
Missing This property is required. boolean - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- cluster
Type This property is required. string - Immutable. The on prem cluster's type.
- resource
Link This property is required. string - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
- admin_
cluster This property is required. bool - Immutable. Whether the cluster is an admin cluster.
- cluster_
missing This property is required. bool - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- cluster_
type This property is required. str - Immutable. The on prem cluster's type.
- resource_
link This property is required. str - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
- admin
Cluster This property is required. Boolean - Immutable. Whether the cluster is an admin cluster.
- cluster
Missing This property is required. Boolean - If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.
- cluster
Type This property is required. String - Immutable. The on prem cluster's type.
- resource
Link This property is required. String - Immutable. Self-link of the Google Cloud resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster
ResourceManifestResponse
- Cluster
Scoped This property is required. bool - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - Manifest
This property is required. string - YAML manifest of the resource.
- Cluster
Scoped This property is required. bool - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - Manifest
This property is required. string - YAML manifest of the resource.
- cluster
Scoped This property is required. Boolean - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - manifest
This property is required. String - YAML manifest of the resource.
- cluster
Scoped This property is required. boolean - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - manifest
This property is required. string - YAML manifest of the resource.
- cluster_
scoped This property is required. bool - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - manifest
This property is required. str - YAML manifest of the resource.
- cluster
Scoped This property is required. Boolean - Whether the resource provided in the manifest is
cluster_scoped
. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster. - manifest
This property is required. String - YAML manifest of the resource.
ResourceOptionsResponse
- Connect
Version This property is required. string - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- K8s
Version This property is required. string - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - V1beta1Crd
This property is required. bool - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
- Connect
Version This property is required. string - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- K8s
Version This property is required. string - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - V1beta1Crd
This property is required. bool - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
- connect
Version This property is required. String - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- k8s
Version This property is required. String - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - v1beta1Crd
This property is required. Boolean - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
- connect
Version This property is required. string - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- k8s
Version This property is required. string - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - v1beta1Crd
This property is required. boolean - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
- connect_
version This property is required. str - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- k8s_
version This property is required. str - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - v1beta1_
crd This property is required. bool - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
- connect
Version This property is required. String - Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.
- k8s
Version This property is required. String - Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources,
apiextensions/v1beta1
orapiextensions/v1
. - v1beta1Crd
This property is required. Boolean - Optional. Use
apiextensions/v1beta1
instead ofapiextensions/v1
for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi