@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
122 lines • 5.36 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.WorkloadIdentityPool = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Represents a collection of external workload identities. You can define IAM policies to
* grant these identities access to Google Cloud resources.
*
* To get more information about WorkloadIdentityPool, see:
*
* * [API documentation](https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools)
* * How-to Guides
* * [Managing workload identity pools](https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers#pools)
*
* ## Example Usage
*
* ### Iam Workload Identity Pool Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.iam.WorkloadIdentityPool("example", {workloadIdentityPoolId: "example-pool"});
* ```
* ### Iam Workload Identity Pool Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.iam.WorkloadIdentityPool("example", {
* workloadIdentityPoolId: "example-pool",
* displayName: "Name of pool",
* description: "Identity pool for automated test",
* disabled: true,
* });
* ```
*
* ## Import
*
* WorkloadIdentityPool can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}`
*
* * `{{project}}/{{workload_identity_pool_id}}`
*
* * `{{workload_identity_pool_id}}`
*
* When using the `pulumi import` command, WorkloadIdentityPool can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:iam/workloadIdentityPool:WorkloadIdentityPool default projects/{{project}}/locations/global/workloadIdentityPools/{{workload_identity_pool_id}}
* ```
*
* ```sh
* $ pulumi import gcp:iam/workloadIdentityPool:WorkloadIdentityPool default {{project}}/{{workload_identity_pool_id}}
* ```
*
* ```sh
* $ pulumi import gcp:iam/workloadIdentityPool:WorkloadIdentityPool default {{workload_identity_pool_id}}
* ```
*/
class WorkloadIdentityPool extends pulumi.CustomResource {
/**
* Get an existing WorkloadIdentityPool 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, id, state, opts) {
return new WorkloadIdentityPool(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of WorkloadIdentityPool. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === WorkloadIdentityPool.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["disabled"] = state ? state.disabled : undefined;
resourceInputs["displayName"] = state ? state.displayName : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["state"] = state ? state.state : undefined;
resourceInputs["workloadIdentityPoolId"] = state ? state.workloadIdentityPoolId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.workloadIdentityPoolId === undefined) && !opts.urn) {
throw new Error("Missing required property 'workloadIdentityPoolId'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["disabled"] = args ? args.disabled : undefined;
resourceInputs["displayName"] = args ? args.displayName : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["workloadIdentityPoolId"] = args ? args.workloadIdentityPoolId : undefined;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(WorkloadIdentityPool.__pulumiType, name, resourceInputs, opts);
}
}
exports.WorkloadIdentityPool = WorkloadIdentityPool;
/** @internal */
WorkloadIdentityPool.__pulumiType = 'gcp:iam/workloadIdentityPool:WorkloadIdentityPool';
//# sourceMappingURL=workloadIdentityPool.js.map