@pulumi/gcp/iap/client.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * 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}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:iap/client:Client default {{brand}}/{{client_id}}
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: ClientState, opts?: pulumi.CustomResourceOptions): 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: any): obj is Client;
    /**
     * Identifier of the brand to which this client
     * is attached to. The format is
     * `projects/{project_number}/brands/{brand_id}`.
     *
     *
     * - - -
     */
    readonly brand: pulumi.Output<string>;
    /**
     * Output only. Unique identifier of the OAuth client.
     */
    readonly clientId: pulumi.Output<string>;
    /**
     * Human-friendly name given to the OAuth client.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Output only. Client secret of the OAuth client.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    readonly secret: pulumi.Output<string>;
    /**
     * Create a Client 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: ClientArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Client resources.
 */
export interface ClientState {
    /**
     * Identifier of the brand to which this client
     * is attached to. The format is
     * `projects/{project_number}/brands/{brand_id}`.
     *
     *
     * - - -
     */
    brand?: pulumi.Input<string>;
    /**
     * Output only. Unique identifier of the OAuth client.
     */
    clientId?: pulumi.Input<string>;
    /**
     * Human-friendly name given to the OAuth client.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Output only. Client secret of the OAuth client.
     * **Note**: This property is sensitive and will not be displayed in the plan.
     */
    secret?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Client resource.
 */
export interface ClientArgs {
    /**
     * Identifier of the brand to which this client
     * is attached to. The format is
     * `projects/{project_number}/brands/{brand_id}`.
     *
     *
     * - - -
     */
    brand: pulumi.Input<string>;
    /**
     * Human-friendly name given to the OAuth client.
     */
    displayName: pulumi.Input<string>;
}