Google Cloud Classic v7.29.0, Jun 26 24

Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

gcp.gkehub.Membership

Explore with Pulumi AI

Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-gcp

Example Usage

Gkehub Membership Regional

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const primary = new gcp.container.Cluster("primary", {
    name: "basic-cluster",
    location: "us-central1-a",
    initialNodeCount: 1,
    deletionProtection: false,
    network: "default",
    subnetwork: "default",
});
const membership = new gcp.gkehub.Membership("membership", {
    membershipId: "basic",
    location: "us-west1",
    endpoint: {
        gkeCluster: {
            resourceLink: pulumi.interpolate`//container.googleapis.com/${primary.id}`,
        },
    },
});

import pulumi
import pulumi_gcp as gcp

primary = gcp.container.Cluster("primary",
    name="basic-cluster",
    location="us-central1-a",
    initial_node_count=1,
    deletion_protection=False,
    network="default",
    subnetwork="default")
membership = gcp.gkehub.Membership("membership",
    membership_id="basic",
    location="us-west1",
    endpoint=gcp.gkehub.MembershipEndpointArgs(
        gke_cluster=gcp.gkehub.MembershipEndpointGkeClusterArgs(
            resource_link=primary.id.apply(lambda id: f"//container.googleapis.com/{id}"),
        ),
    ))

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/container"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/gkehub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		primary, err := container.NewCluster(ctx, "primary", &container.ClusterArgs{
			Name:               pulumi.String("basic-cluster"),
			Location:           pulumi.String("us-central1-a"),
			InitialNodeCount:   pulumi.Int(1),
			DeletionProtection: pulumi.Bool(false),
			Network:            pulumi.String("default"),
			Subnetwork:         pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = gkehub.NewMembership(ctx, "membership", &gkehub.MembershipArgs{
			MembershipId: pulumi.String("basic"),
			Location:     pulumi.String("us-west1"),
			Endpoint: &gkehub.MembershipEndpointArgs{
				GkeCluster: &gkehub.MembershipEndpointGkeClusterArgs{
					ResourceLink: primary.ID().ApplyT(func(id string) (string, error) {
						return fmt.Sprintf("//container.googleapis.com/%v", id), nil
					}).(pulumi.StringOutput),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Container.Cluster("primary", new()
    {
        Name = "basic-cluster",
        Location = "us-central1-a",
        InitialNodeCount = 1,
        DeletionProtection = false,
        Network = "default",
        Subnetwork = "default",
    });

    var membership = new Gcp.GkeHub.Membership("membership", new()
    {
        MembershipId = "basic",
        Location = "us-west1",
        Endpoint = new Gcp.GkeHub.Inputs.MembershipEndpointArgs
        {
            GkeCluster = new Gcp.GkeHub.Inputs.MembershipEndpointGkeClusterArgs
            {
                ResourceLink = primary.Id.Apply(id => $"//container.googleapis.com/{id}"),
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.gkehub.Membership;
import com.pulumi.gcp.gkehub.MembershipArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointGkeClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .name("basic-cluster")
            .location("us-central1-a")
            .initialNodeCount(1)
            .deletionProtection(false)
            .network("default")
            .subnetwork("default")
            .build());

        var membership = new Membership("membership", MembershipArgs.builder()
            .membershipId("basic")
            .location("us-west1")
            .endpoint(MembershipEndpointArgs.builder()
                .gkeCluster(MembershipEndpointGkeClusterArgs.builder()
                    .resourceLink(primary.id().applyValue(id -> String.format("//container.googleapis.com/%s", id)))
                    .build())
                .build())
            .build());

    }
}

resources:
  primary:
    type: gcp:container:Cluster
    properties:
      name: basic-cluster
      location: us-central1-a
      initialNodeCount: 1
      deletionProtection: false
      network: default
      subnetwork: default
  membership:
    type: gcp:gkehub:Membership
    properties:
      membershipId: basic
      location: us-west1
      endpoint:
        gkeCluster:
          resourceLink: //container.googleapis.com/${primary.id}

Gkehub Membership Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const primary = new gcp.container.Cluster("primary", {
    name: "basic-cluster",
    location: "us-central1-a",
    initialNodeCount: 1,
    deletionProtection: true,
    network: "default",
    subnetwork: "default",
});
const membership = new gcp.gkehub.Membership("membership", {
    membershipId: "basic",
    endpoint: {
        gkeCluster: {
            resourceLink: pulumi.interpolate`//container.googleapis.com/${primary.id}`,
        },
    },
    labels: {
        env: "test",
    },
});

import pulumi
import pulumi_gcp as gcp

primary = gcp.container.Cluster("primary",
    name="basic-cluster",
    location="us-central1-a",
    initial_node_count=1,
    deletion_protection=True,
    network="default",
    subnetwork="default")
membership = gcp.gkehub.Membership("membership",
    membership_id="basic",
    endpoint=gcp.gkehub.MembershipEndpointArgs(
        gke_cluster=gcp.gkehub.MembershipEndpointGkeClusterArgs(
            resource_link=primary.id.apply(lambda id: f"//container.googleapis.com/{id}"),
        ),
    ),
    labels={
        "env": "test",
    })

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/container"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/gkehub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		primary, err := container.NewCluster(ctx, "primary", &container.ClusterArgs{
			Name:               pulumi.String("basic-cluster"),
			Location:           pulumi.String("us-central1-a"),
			InitialNodeCount:   pulumi.Int(1),
			DeletionProtection: pulumi.Bool(true),
			Network:            pulumi.String("default"),
			Subnetwork:         pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = gkehub.NewMembership(ctx, "membership", &gkehub.MembershipArgs{
			MembershipId: pulumi.String("basic"),
			Endpoint: &gkehub.MembershipEndpointArgs{
				GkeCluster: &gkehub.MembershipEndpointGkeClusterArgs{
					ResourceLink: primary.ID().ApplyT(func(id string) (string, error) {
						return fmt.Sprintf("//container.googleapis.com/%v", id), nil
					}).(pulumi.StringOutput),
				},
			},
			Labels: pulumi.StringMap{
				"env": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Container.Cluster("primary", new()
    {
        Name = "basic-cluster",
        Location = "us-central1-a",
        InitialNodeCount = 1,
        DeletionProtection = true,
        Network = "default",
        Subnetwork = "default",
    });

    var membership = new Gcp.GkeHub.Membership("membership", new()
    {
        MembershipId = "basic",
        Endpoint = new Gcp.GkeHub.Inputs.MembershipEndpointArgs
        {
            GkeCluster = new Gcp.GkeHub.Inputs.MembershipEndpointGkeClusterArgs
            {
                ResourceLink = primary.Id.Apply(id => $"//container.googleapis.com/{id}"),
            },
        },
        Labels = 
        {
            { "env", "test" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.gkehub.Membership;
import com.pulumi.gcp.gkehub.MembershipArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointGkeClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .name("basic-cluster")
            .location("us-central1-a")
            .initialNodeCount(1)
            .deletionProtection("true")
            .network("default")
            .subnetwork("default")
            .build());

        var membership = new Membership("membership", MembershipArgs.builder()
            .membershipId("basic")
            .endpoint(MembershipEndpointArgs.builder()
                .gkeCluster(MembershipEndpointGkeClusterArgs.builder()
                    .resourceLink(primary.id().applyValue(id -> String.format("//container.googleapis.com/%s", id)))
                    .build())
                .build())
            .labels(Map.of("env", "test"))
            .build());

    }
}

resources:
  primary:
    type: gcp:container:Cluster
    properties:
      name: basic-cluster
      location: us-central1-a
      initialNodeCount: 1
      deletionProtection: 'true'
      network: default
      subnetwork: default
  membership:
    type: gcp:gkehub:Membership
    properties:
      membershipId: basic
      endpoint:
        gkeCluster:
          resourceLink: //container.googleapis.com/${primary.id}
      labels:
        env: test

Gkehub Membership Issuer

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const primary = new gcp.container.Cluster("primary", {
    name: "basic-cluster",
    location: "us-central1-a",
    initialNodeCount: 1,
    workloadIdentityConfig: {
        workloadPool: "my-project-name.svc.id.goog",
    },
    deletionProtection: true,
    network: "default",
    subnetwork: "default",
});
const membership = new gcp.gkehub.Membership("membership", {
    membershipId: "basic",
    endpoint: {
        gkeCluster: {
            resourceLink: primary.id,
        },
    },
    authority: {
        issuer: pulumi.interpolate`https://container.googleapis.com/v1/${primary.id}`,
    },
});

import pulumi
import pulumi_gcp as gcp

primary = gcp.container.Cluster("primary",
    name="basic-cluster",
    location="us-central1-a",
    initial_node_count=1,
    workload_identity_config=gcp.container.ClusterWorkloadIdentityConfigArgs(
        workload_pool="my-project-name.svc.id.goog",
    ),
    deletion_protection=True,
    network="default",
    subnetwork="default")
membership = gcp.gkehub.Membership("membership",
    membership_id="basic",
    endpoint=gcp.gkehub.MembershipEndpointArgs(
        gke_cluster=gcp.gkehub.MembershipEndpointGkeClusterArgs(
            resource_link=primary.id,
        ),
    ),
    authority=gcp.gkehub.MembershipAuthorityArgs(
        issuer=primary.id.apply(lambda id: f"https://container.googleapis.com/v1/{id}"),
    ))

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/container"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/gkehub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		primary, err := container.NewCluster(ctx, "primary", &container.ClusterArgs{
			Name:             pulumi.String("basic-cluster"),
			Location:         pulumi.String("us-central1-a"),
			InitialNodeCount: pulumi.Int(1),
			WorkloadIdentityConfig: &container.ClusterWorkloadIdentityConfigArgs{
				WorkloadPool: pulumi.String("my-project-name.svc.id.goog"),
			},
			DeletionProtection: pulumi.Bool(true),
			Network:            pulumi.String("default"),
			Subnetwork:         pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = gkehub.NewMembership(ctx, "membership", &gkehub.MembershipArgs{
			MembershipId: pulumi.String("basic"),
			Endpoint: &gkehub.MembershipEndpointArgs{
				GkeCluster: &gkehub.MembershipEndpointGkeClusterArgs{
					ResourceLink: primary.ID(),
				},
			},
			Authority: &gkehub.MembershipAuthorityArgs{
				Issuer: primary.ID().ApplyT(func(id string) (string, error) {
					return fmt.Sprintf("https://container.googleapis.com/v1/%v", id), nil
				}).(pulumi.StringOutput),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Container.Cluster("primary", new()
    {
        Name = "basic-cluster",
        Location = "us-central1-a",
        InitialNodeCount = 1,
        WorkloadIdentityConfig = new Gcp.Container.Inputs.ClusterWorkloadIdentityConfigArgs
        {
            WorkloadPool = "my-project-name.svc.id.goog",
        },
        DeletionProtection = true,
        Network = "default",
        Subnetwork = "default",
    });

    var membership = new Gcp.GkeHub.Membership("membership", new()
    {
        MembershipId = "basic",
        Endpoint = new Gcp.GkeHub.Inputs.MembershipEndpointArgs
        {
            GkeCluster = new Gcp.GkeHub.Inputs.MembershipEndpointGkeClusterArgs
            {
                ResourceLink = primary.Id,
            },
        },
        Authority = new Gcp.GkeHub.Inputs.MembershipAuthorityArgs
        {
            Issuer = primary.Id.Apply(id => $"https://container.googleapis.com/v1/{id}"),
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.gkehub.Membership;
import com.pulumi.gcp.gkehub.MembershipArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipEndpointGkeClusterArgs;
import com.pulumi.gcp.gkehub.inputs.MembershipAuthorityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .name("basic-cluster")
            .location("us-central1-a")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .deletionProtection("true")
            .network("default")
            .subnetwork("default")
            .build());

        var membership = new Membership("membership", MembershipArgs.builder()
            .membershipId("basic")
            .endpoint(MembershipEndpointArgs.builder()
                .gkeCluster(MembershipEndpointGkeClusterArgs.builder()
                    .resourceLink(primary.id())
                    .build())
                .build())
            .authority(MembershipAuthorityArgs.builder()
                .issuer(primary.id().applyValue(id -> String.format("https://container.googleapis.com/v1/%s", id)))
                .build())
            .build());

    }
}

resources:
  primary:
    type: gcp:container:Cluster
    properties:
      name: basic-cluster
      location: us-central1-a
      initialNodeCount: 1
      workloadIdentityConfig:
        workloadPool: my-project-name.svc.id.goog
      deletionProtection: 'true'
      network: default
      subnetwork: default
  membership:
    type: gcp:gkehub:Membership
    properties:
      membershipId: basic
      endpoint:
        gkeCluster:
          resourceLink: ${primary.id}
      authority:
        issuer: https://container.googleapis.com/v1/${primary.id}

Create Membership Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Membership(name: string, args: MembershipArgs, opts?: CustomResourceOptions);

@overload
def Membership(resource_name: str,
               args: MembershipArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Membership(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               membership_id: Optional[str] = None,
               authority: Optional[MembershipAuthorityArgs] = None,
               description: Optional[str] = None,
               endpoint: Optional[MembershipEndpointArgs] = None,
               labels: Optional[Mapping[str, str]] = None,
               location: Optional[str] = None,
               project: Optional[str] = None)

func NewMembership(ctx *Context, name string, args MembershipArgs, opts ...ResourceOption) (*Membership, error)

public Membership(string name, MembershipArgs args, CustomResourceOptions? opts = null)

public Membership(String name, MembershipArgs args)
public Membership(String name, MembershipArgs args, CustomResourceOptions options)

type: gcp:gkehub:Membership
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args MembershipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MembershipArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MembershipArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MembershipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MembershipArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var membershipResource = new Gcp.GkeHub.Membership("membershipResource", new()
{
    MembershipId = "string",
    Authority = new Gcp.GkeHub.Inputs.MembershipAuthorityArgs
    {
        Issuer = "string",
    },
    Endpoint = new Gcp.GkeHub.Inputs.MembershipEndpointArgs
    {
        GkeCluster = new Gcp.GkeHub.Inputs.MembershipEndpointGkeClusterArgs
        {
            ResourceLink = "string",
        },
    },
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});

example, err := gkehub.NewMembership(ctx, "membershipResource", &gkehub.MembershipArgs{
	MembershipId: pulumi.String("string"),
	Authority: &gkehub.MembershipAuthorityArgs{
		Issuer: pulumi.String("string"),
	},
	Endpoint: &gkehub.MembershipEndpointArgs{
		GkeCluster: &gkehub.MembershipEndpointGkeClusterArgs{
			ResourceLink: pulumi.String("string"),
		},
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})

var membershipResource = new Membership("membershipResource", MembershipArgs.builder()
    .membershipId("string")
    .authority(MembershipAuthorityArgs.builder()
        .issuer("string")
        .build())
    .endpoint(MembershipEndpointArgs.builder()
        .gkeCluster(MembershipEndpointGkeClusterArgs.builder()
            .resourceLink("string")
            .build())
        .build())
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());

membership_resource = gcp.gkehub.Membership("membershipResource",
    membership_id="string",
    authority=gcp.gkehub.MembershipAuthorityArgs(
        issuer="string",
    ),
    endpoint=gcp.gkehub.MembershipEndpointArgs(
        gke_cluster=gcp.gkehub.MembershipEndpointGkeClusterArgs(
            resource_link="string",
        ),
    ),
    labels={
        "string": "string",
    },
    location="string",
    project="string")

const membershipResource = new gcp.gkehub.Membership("membershipResource", {
    membershipId: "string",
    authority: {
        issuer: "string",
    },
    endpoint: {
        gkeCluster: {
            resourceLink: "string",
        },
    },
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});

type: gcp:gkehub:Membership
properties:
    authority:
        issuer: string
    endpoint:
        gkeCluster:
            resourceLink: string
    labels:
        string: string
    location: string
    membershipId: string
    project: string

Membership Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Membership resource accepts the following input properties:

MembershipId string

The client-provided identifier of the membership.

Authority MembershipAuthority

Authority 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 Structure is documented below.

Description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

Endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

Labels Dictionary<string, string>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Location of the membership. The default value is global.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

MembershipId string

The client-provided identifier of the membership.

Authority MembershipAuthorityArgs

Description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

Endpoint MembershipEndpointArgs

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

Labels map[string]string

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Location of the membership. The default value is global.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

membershipId String

The client-provided identifier of the membership.

authority MembershipAuthority

description String

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Map<String,String>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

Location of the membership. The default value is global.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

membershipId string

The client-provided identifier of the membership.

authority MembershipAuthority

description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels {[key: string]: string}

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location string

Location of the membership. The default value is global.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

membership_id str

The client-provided identifier of the membership.

authority MembershipAuthorityArgs

description str

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

endpoint MembershipEndpointArgs

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Mapping[str, str]

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location str

Location of the membership. The default value is global.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

membershipId String

The client-provided identifier of the membership.

authority Property Map

description String

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

endpoint Property Map

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Map<String>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

Location of the membership. The default value is global.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Membership resource produces the following output properties:

EffectiveLabels Dictionary<string, string>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique identifier of the membership.
PulumiLabels Dictionary<string, string>: The combination of labels configured directly on the resource and default labels configured on the provider.

EffectiveLabels map[string]string: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique identifier of the membership.
PulumiLabels map[string]string: The combination of labels configured directly on the resource and default labels configured on the provider.

effectiveLabels Map<String,String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String: The provider-assigned unique ID for this managed resource.
name String: The unique identifier of the membership.
pulumiLabels Map<String,String>: The combination of labels configured directly on the resource and default labels configured on the provider.

effectiveLabels {[key: string]: string}: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id string: The provider-assigned unique ID for this managed resource.
name string: The unique identifier of the membership.
pulumiLabels {[key: string]: string}: The combination of labels configured directly on the resource and default labels configured on the provider.

effective_labels Mapping[str, str]: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id str: The provider-assigned unique ID for this managed resource.
name str: The unique identifier of the membership.
pulumi_labels Mapping[str, str]: The combination of labels configured directly on the resource and default labels configured on the provider.

effectiveLabels Map<String>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String: The provider-assigned unique ID for this managed resource.
name String: The unique identifier of the membership.
pulumiLabels Map<String>: The combination of labels configured directly on the resource and default labels configured on the provider.

Look up Existing Membership Resource

Get an existing Membership resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MembershipState, opts?: CustomResourceOptions): Membership

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authority: Optional[MembershipAuthorityArgs] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        endpoint: Optional[MembershipEndpointArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        membership_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None) -> Membership

func GetMembership(ctx *Context, name string, id IDInput, state *MembershipState, opts ...ResourceOption) (*Membership, error)

public static Membership Get(string name, Input<string> id, MembershipState? state, CustomResourceOptions? opts = null)

public static Membership get(String name, Output<String> id, MembershipState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Authority MembershipAuthority

Description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

EffectiveLabels Dictionary<string, string>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

Labels Dictionary<string, string>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Location of the membership. The default value is global.

MembershipId string

The client-provided identifier of the membership.

Name string

The unique identifier of the membership.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PulumiLabels Dictionary<string, string>

The combination of labels configured directly on the resource and default labels configured on the provider.

Authority MembershipAuthorityArgs

Description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

EffectiveLabels map[string]string

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Endpoint MembershipEndpointArgs

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

Labels map[string]string

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string

Location of the membership. The default value is global.

MembershipId string

The client-provided identifier of the membership.

Name string

The unique identifier of the membership.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

PulumiLabels map[string]string

The combination of labels configured directly on the resource and default labels configured on the provider.

authority MembershipAuthority

description String

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

effectiveLabels Map<String,String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Map<String,String>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

Location of the membership. The default value is global.

membershipId String

The client-provided identifier of the membership.

name String

The unique identifier of the membership.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels Map<String,String>

The combination of labels configured directly on the resource and default labels configured on the provider.

authority MembershipAuthority

description string

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

effectiveLabels {[key: string]: string}

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

endpoint MembershipEndpoint

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels {[key: string]: string}

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location string

Location of the membership. The default value is global.

membershipId string

The client-provided identifier of the membership.

name string

The unique identifier of the membership.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels {[key: string]: string}

The combination of labels configured directly on the resource and default labels configured on the provider.

authority MembershipAuthorityArgs

description str

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

effective_labels Mapping[str, str]

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

endpoint MembershipEndpointArgs

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Mapping[str, str]

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location str

Location of the membership. The default value is global.

membership_id str

The client-provided identifier of the membership.

name str

The unique identifier of the membership.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_labels Mapping[str, str]

The combination of labels configured directly on the resource and default labels configured on the provider.

authority Property Map

description String

The name of this entity type to be displayed on the console. This field is unavailable in v1 of the API.

Deprecated: description is deprecated and will be removed in a future major release.

effectiveLabels Map<String>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

endpoint Property Map

If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

labels Map<String>

Labels to apply to this membership.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String

Location of the membership. The default value is global.

membershipId String

The client-provided identifier of the membership.

name String

The unique identifier of the membership.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiLabels Map<String>

The combination of labels configured directly on the resource and default labels configured on the provider.

Supporting Types

MembershipAuthority, MembershipAuthorityArgs

Issuer string

Issuer string

issuer String

issuer string

issuer str

issuer String

MembershipEndpoint, MembershipEndpointArgs

GkeCluster MembershipEndpointGkeCluster: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

GkeCluster MembershipEndpointGkeCluster: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

gkeCluster MembershipEndpointGkeCluster: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

gkeCluster MembershipEndpointGkeCluster: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

gke_cluster MembershipEndpointGkeCluster: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

gkeCluster Property Map: If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource. Structure is documented below.

MembershipEndpointGkeCluster, MembershipEndpointGkeClusterArgs

ResourceLink string

ResourceLink string

resourceLink String

resourceLink string

resource_link str

resourceLink String

Import

Membership can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/memberships/{{membership_id}}
{{project}}/{{location}}/{{membership_id}}
{{location}}/{{membership_id}}

When using the pulumi import command, Membership can be imported using one of the formats above. For example:

$ pulumi import gcp:gkehub/membership:Membership default projects/{{project}}/locations/{{location}}/memberships/{{membership_id}}

$ pulumi import gcp:gkehub/membership:Membership default {{project}}/{{location}}/{{membership_id}}

$ pulumi import gcp:gkehub/membership:Membership default {{location}}/{{membership_id}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.gkehub.Membership

On this page

On this page

Example Usage

Gkehub Membership Regional

Gkehub Membership Basic

Gkehub Membership Issuer

Create Membership Resource

Constructor syntax

Parameters

Constructor example

Membership Resource Properties

Inputs

Outputs

Look up Existing Membership Resource

Supporting Types

MembershipAuthority, MembershipAuthorityArgs

MembershipEndpoint, MembershipEndpointArgs

MembershipEndpointGkeCluster, MembershipEndpointGkeClusterArgs

Import

Package Details

On this page

On this page