@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
312 lines • 12.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Membership contains information about a member cluster.
*
* To get more information about Membership, see:
*
* * [API documentation](https://cloud.google.com/anthos/multicluster-management/reference/rest/v1/projects.locations.memberships)
* * How-to Guides
* * [Registering a Cluster](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
*
* ## Example Usage
*
* ### Gkehub Membership Regional
*
* ```typescript
* 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}`,
* },
* },
* });
* ```
* ### Gkehub Membership Basic
*
* ```typescript
* 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",
* },
* });
* ```
* ### Gkehub Membership Issuer
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ 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}}
* ```
*/
export declare class Membership extends pulumi.CustomResource {
/**
* Get an existing Membership resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MembershipState, opts?: pulumi.CustomResourceOptions): Membership;
/**
* Returns true if the given object is an instance of Membership. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Membership;
/**
* 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.
*/
readonly authority: pulumi.Output<outputs.gkehub.MembershipAuthority | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource.
* Structure is documented below.
*/
readonly endpoint: pulumi.Output<outputs.gkehub.MembershipEndpoint | undefined>;
/**
* 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 `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Location of the membership.
* The default value is `global`.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The client-provided identifier of the membership.
*/
readonly membershipId: pulumi.Output<string>;
/**
* The unique identifier of the membership.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Membership resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MembershipArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Membership resources.
*/
export interface MembershipState {
/**
* 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.
*/
authority?: pulumi.Input<inputs.gkehub.MembershipAuthority | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource.
* Structure is documented below.
*/
endpoint?: pulumi.Input<inputs.gkehub.MembershipEndpoint | undefined>;
/**
* 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 `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Location of the membership.
* The default value is `global`.
*/
location?: pulumi.Input<string | undefined>;
/**
* The client-provided identifier of the membership.
*/
membershipId?: pulumi.Input<string | undefined>;
/**
* The unique identifier of the membership.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a Membership resource.
*/
export interface MembershipArgs {
/**
* 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.
*/
authority?: pulumi.Input<inputs.gkehub.MembershipAuthority | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* If this Membership is a Kubernetes API server hosted on GKE, this is a self link to its GCP resource.
* Structure is documented below.
*/
endpoint?: pulumi.Input<inputs.gkehub.MembershipEndpoint | undefined>;
/**
* 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 `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Location of the membership.
* The default value is `global`.
*/
location?: pulumi.Input<string | undefined>;
/**
* The client-provided identifier of the membership.
*/
membershipId: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=membership.d.ts.map