@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
146 lines • 6.21 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Client = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* > **Warning:** This resource is deprecated on Jan 22, 2025. After Jan 19, 2026 the `gcp.iap.Client` Terraform resource will no longer function as intended due to the deprecation of the IAP OAuth Admin APIs. New projects will not be able to use these APIs. March 19, 2026 The IAP OAuth Admin APIs will be permanently shut down. Access to this feature will no longer be available.
*
* Contains the data that describes an Identity Aware Proxy owned client.
*
* > **Note:** Only internal org clients can be created via declarative tools. External clients must be
* manually created via the GCP console. This restriction is due to the existing APIs and not lack of support
* in this tool.
*
* To get more information about Client, see:
*
* * [API documentation](https://cloud.google.com/iap/docs/reference/rest/v1/projects.brands.identityAwareProxyClients)
* * How-to Guides
* * [Setting up IAP Client](https://cloud.google.com/iap/docs/authentication-howto)
*
* ## Example Usage
*
* ### Iap Client
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = new gcp.organizations.Project("project", {
* projectId: "my-project",
* name: "my-project",
* orgId: "123456789",
* deletionPolicy: "DELETE",
* });
* const projectService = new gcp.projects.Service("project_service", {
* project: project.projectId,
* service: "iap.googleapis.com",
* });
* const projectBrand = new gcp.iap.Brand("project_brand", {
* supportEmail: "support@example.com",
* applicationTitle: "Cloud IAP protected Application",
* project: projectService.project,
* });
* const projectClient = new gcp.iap.Client("project_client", {
* displayName: "Test Client",
* brand: projectBrand.name,
* });
* ```
*
* ## Import
*
* Client can be imported using any of these accepted formats:
*
* * `{{brand}}/identityAwareProxyClients/{{client_id}}`
* * `{{brand}}/{{client_id}}`
*
* When using the `pulumi import` command, Client can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:iap/client:Client default {{brand}}/identityAwareProxyClients/{{client_id}}
* $ pulumi import gcp:iap/client:Client default {{brand}}/{{client_id}}
* ```
*/
class Client extends pulumi.CustomResource {
/**
* Get an existing Client 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 Client(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:iap/client:Client';
/**
* Returns true if the given object is an instance of Client. 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'] === Client.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["brand"] = state?.brand;
resourceInputs["clientId"] = state?.clientId;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["secret"] = state?.secret;
}
else {
const args = argsOrState;
if (args?.brand === undefined && !opts.urn) {
throw new Error("Missing required property 'brand'");
}
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
resourceInputs["brand"] = args?.brand;
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["clientId"] = undefined /*out*/;
resourceInputs["secret"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["secret"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Client.__pulumiType, name, resourceInputs, opts);
}
}
exports.Client = Client;
//# sourceMappingURL=client.js.map