@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
100 lines • 3.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves the details of a specific GKE Hub Membership. Use this data source to retrieve the membership's configuration and state.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.gkehub.getMembership({
* project: "my-project-id",
* location: "global",
* membershipId: "my-membership-id",
* });
* ```
*/
export declare function getMembership(args: GetMembershipArgs, opts?: pulumi.InvokeOptions): Promise<GetMembershipResult>;
/**
* A collection of arguments for invoking getMembership.
*/
export interface GetMembershipArgs {
/**
* The location for the GKE Hub Membership.
* Currently only `global` is supported.
*/
location: string;
/**
* The GKE Hub Membership id or GKE Cluster's name.
*/
membershipId: string;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: string;
}
/**
* A collection of values returned by getMembership.
*/
export interface GetMembershipResult {
readonly authorities: outputs.gkehub.GetMembershipAuthority[];
readonly deletionPolicy: string;
readonly effectiveLabels: {
[key: string]: string;
};
readonly endpoints: outputs.gkehub.GetMembershipEndpoint[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly labels: {
[key: string]: string;
};
readonly location: string;
readonly membershipId: string;
readonly name: string;
readonly project?: string;
readonly pulumiLabels: {
[key: string]: string;
};
}
/**
* Retrieves the details of a specific GKE Hub Membership. Use this data source to retrieve the membership's configuration and state.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = gcp.gkehub.getMembership({
* project: "my-project-id",
* location: "global",
* membershipId: "my-membership-id",
* });
* ```
*/
export declare function getMembershipOutput(args: GetMembershipOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMembershipResult>;
/**
* A collection of arguments for invoking getMembership.
*/
export interface GetMembershipOutputArgs {
/**
* The location for the GKE Hub Membership.
* Currently only `global` is supported.
*/
location: pulumi.Input<string>;
/**
* The GKE Hub Membership id or GKE Cluster's name.
*/
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=getMembership.d.ts.map