UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

135 lines 5.52 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.TenantInboundSamlConfig = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Inbound SAML configuration for a Identity Toolkit tenant. * * You must enable the * [Google Identity Platform](https://console.cloud.google.com/marketplace/details/google-cloud-platform/customer-identity) in * the marketplace prior to using this resource. * * ## Example Usage * * ### Identity Platform Tenant Inbound Saml Config Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as std from "@pulumi/std"; * * const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"}); * const tenantSamlConfig = new gcp.identityplatform.TenantInboundSamlConfig("tenant_saml_config", { * name: "saml.tf-config", * displayName: "Display Name", * tenant: tenant.name, * idpConfig: { * idpEntityId: "tf-idp", * signRequest: true, * ssoUrl: "https://example.com", * idpCertificates: [{ * x509Certificate: std.file({ * input: "test-fixtures/rsa_cert.pem", * }).then(invoke => invoke.result), * }], * }, * spConfig: { * spEntityId: "tf-sp", * callbackUri: "https://example.com", * }, * }); * ``` * * ## Import * * TenantInboundSamlConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/tenants/{{tenant}}/inboundSamlConfigs/{{name}}` * * * `{{project}}/{{tenant}}/{{name}}` * * * `{{tenant}}/{{name}}` * * When using the `pulumi import` command, TenantInboundSamlConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default projects/{{project}}/tenants/{{tenant}}/inboundSamlConfigs/{{name}} * ``` * * ```sh * $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default {{project}}/{{tenant}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default {{tenant}}/{{name}} * ``` */ class TenantInboundSamlConfig extends pulumi.CustomResource { /** * Get an existing TenantInboundSamlConfig 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 TenantInboundSamlConfig(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of TenantInboundSamlConfig. 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'] === TenantInboundSamlConfig.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["displayName"] = state?.displayName; resourceInputs["enabled"] = state?.enabled; resourceInputs["idpConfig"] = state?.idpConfig; resourceInputs["name"] = state?.name; resourceInputs["project"] = state?.project; resourceInputs["spConfig"] = state?.spConfig; resourceInputs["tenant"] = state?.tenant; } else { const args = argsOrState; if (args?.displayName === undefined && !opts.urn) { throw new Error("Missing required property 'displayName'"); } if (args?.idpConfig === undefined && !opts.urn) { throw new Error("Missing required property 'idpConfig'"); } if (args?.spConfig === undefined && !opts.urn) { throw new Error("Missing required property 'spConfig'"); } if (args?.tenant === undefined && !opts.urn) { throw new Error("Missing required property 'tenant'"); } resourceInputs["displayName"] = args?.displayName; resourceInputs["enabled"] = args?.enabled; resourceInputs["idpConfig"] = args?.idpConfig; resourceInputs["name"] = args?.name; resourceInputs["project"] = args?.project; resourceInputs["spConfig"] = args?.spConfig; resourceInputs["tenant"] = args?.tenant; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(TenantInboundSamlConfig.__pulumiType, name, resourceInputs, opts); } } exports.TenantInboundSamlConfig = TenantInboundSamlConfig; /** @internal */ TenantInboundSamlConfig.__pulumiType = 'gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig'; //# sourceMappingURL=tenantInboundSamlConfig.js.map