@pulumi/gcp/agentidentity/authProvider.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * An AuthProvider resource in Agent Identity to manage cloud authentication delegation.
 *
 * > **Note:**  All arguments marked as write-only values will not be stored in the state: `auth_provider_type_params.three_legged_oauth.client_secret_wo`, `auth_provider_type_params.two_legged_oauth.client_secret_wo`.
 * Read more about Write-only Arguments.
 *
 * ## Example Usage
 *
 * ### Agent Identity Auth Provider Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.agentidentity.AuthProvider("default", {
 *     location: "us-central1",
 *     authProviderId: "example-provider",
 *     authProviderTypeParams: {
 *         apiKey: {
 *             apiKey: "test-api-key-value",
 *         },
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * AuthProvider can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/authProviders/{{auth_provider_id}}`
 * * `{{project}}/{{location}}/{{auth_provider_id}}`
 * * `{{location}}/{{auth_provider_id}}`
 *
 * When using the `pulumi import` command, AuthProvider can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:agentidentity/authProvider:AuthProvider default projects/{{project}}/locations/{{location}}/authProviders/{{auth_provider_id}}
 * $ pulumi import gcp:agentidentity/authProvider:AuthProvider default {{project}}/{{location}}/{{auth_provider_id}}
 * $ pulumi import gcp:agentidentity/authProvider:AuthProvider default {{location}}/{{auth_provider_id}}
 * ```
 */
export declare class AuthProvider extends pulumi.CustomResource {
    /**
     * Get an existing AuthProvider 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?: AuthProviderState, opts?: pulumi.CustomResourceOptions): AuthProvider;
    /**
     * Returns true if the given object is an instance of AuthProvider.  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 AuthProvider;
    /**
     * List of scopes that are allowed to be requested for this auth_provider.
     * If this list is non-empty, only scopes within this list may be requested.
     * If this list is empty, all scopes may be requested.
     * Scopes appearing in `blockedScopes` are disallowed even if they appear in
     * `allowedScopes`.
     * The number of allowed scopes is limited to 200.
     */
    readonly allowedScopes: pulumi.Output<string[] | undefined>;
    /**
     * The ID to use for the AuthProvider, which will become the final segment
     * of the AuthProvider's resource name.
     * This value should be 1-63 characters, and valid characters
     * are /a-z-/. The first character must be a lowercase letter, and the
     * last character must be a lowercase letter or a number.
     */
    readonly authProviderId: pulumi.Output<string>;
    /**
     * AuthProvider type specific parameters.
     * Required when creating an auth_provider.
     * Structure is documented below.
     */
    readonly authProviderTypeParams: pulumi.Output<outputs.agentidentity.AuthProviderAuthProviderTypeParams>;
    /**
     * List of scopes that are blocked from being requested for this
     * auth_provider. If a scope appears in this list, it will not be requested,
     * even if it also appears in `allowedScopes`. `blockedScopes` takes
     * precedence over `allowedScopes`. The number of blocked scopes is limited
     * to 200.
     */
    readonly blockedScopes: pulumi.Output<string[] | undefined>;
    /**
     * [Output only] Create time stamp
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * This is set to true if the authProvider is deleted.
     */
    readonly deleted: pulumi.Output<boolean>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * Description of the resource.
     * Must be less than 256 characters.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The time when the authProvider will expire.
     */
    readonly expireTime: pulumi.Output<string>;
    /**
     * Labels as key value pairs
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The full resource name of the auth_provider. Format:
     * projects/{project}/locations/{location}/authProviders/{auth_provider}
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The state of the auth_provider.
     * Possible values:
     * ENABLED
     * DISABLED
     */
    readonly state: pulumi.Output<string>;
    /**
     * [Output only] Update time stamp
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Input only. Represents the workload identity in IAM `principal://` format of the
     * agent(s) that will use this AuthProvider. Example:
     * `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
     */
    readonly workloadIds: pulumi.Output<string[] | undefined>;
    /**
     * Create a AuthProvider 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: AuthProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AuthProvider resources.
 */
export interface AuthProviderState {
    /**
     * List of scopes that are allowed to be requested for this auth_provider.
     * If this list is non-empty, only scopes within this list may be requested.
     * If this list is empty, all scopes may be requested.
     * Scopes appearing in `blockedScopes` are disallowed even if they appear in
     * `allowedScopes`.
     * The number of allowed scopes is limited to 200.
     */
    allowedScopes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID to use for the AuthProvider, which will become the final segment
     * of the AuthProvider's resource name.
     * This value should be 1-63 characters, and valid characters
     * are /a-z-/. The first character must be a lowercase letter, and the
     * last character must be a lowercase letter or a number.
     */
    authProviderId?: pulumi.Input<string | undefined>;
    /**
     * AuthProvider type specific parameters.
     * Required when creating an auth_provider.
     * Structure is documented below.
     */
    authProviderTypeParams?: pulumi.Input<inputs.agentidentity.AuthProviderAuthProviderTypeParams | undefined>;
    /**
     * List of scopes that are blocked from being requested for this
     * auth_provider. If a scope appears in this list, it will not be requested,
     * even if it also appears in `allowedScopes`. `blockedScopes` takes
     * precedence over `allowedScopes`. The number of blocked scopes is limited
     * to 200.
     */
    blockedScopes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * [Output only] Create time stamp
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * This is set to true if the authProvider is deleted.
     */
    deleted?: pulumi.Input<boolean | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Description of the resource.
     * Must be less than 256 characters.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The time when the authProvider will expire.
     */
    expireTime?: pulumi.Input<string | undefined>;
    /**
     * Labels as key value pairs
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Identifier. The full resource name of the auth_provider. Format:
     * projects/{project}/locations/{location}/authProviders/{auth_provider}
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * 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>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The state of the auth_provider.
     * Possible values:
     * ENABLED
     * DISABLED
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * [Output only] Update time stamp
     */
    updateTime?: pulumi.Input<string | undefined>;
    /**
     * Input only. Represents the workload identity in IAM `principal://` format of the
     * agent(s) that will use this AuthProvider. Example:
     * `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
     */
    workloadIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
/**
 * The set of arguments for constructing a AuthProvider resource.
 */
export interface AuthProviderArgs {
    /**
     * List of scopes that are allowed to be requested for this auth_provider.
     * If this list is non-empty, only scopes within this list may be requested.
     * If this list is empty, all scopes may be requested.
     * Scopes appearing in `blockedScopes` are disallowed even if they appear in
     * `allowedScopes`.
     * The number of allowed scopes is limited to 200.
     */
    allowedScopes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The ID to use for the AuthProvider, which will become the final segment
     * of the AuthProvider's resource name.
     * This value should be 1-63 characters, and valid characters
     * are /a-z-/. The first character must be a lowercase letter, and the
     * last character must be a lowercase letter or a number.
     */
    authProviderId: pulumi.Input<string>;
    /**
     * AuthProvider type specific parameters.
     * Required when creating an auth_provider.
     * Structure is documented below.
     */
    authProviderTypeParams: pulumi.Input<inputs.agentidentity.AuthProviderAuthProviderTypeParams>;
    /**
     * List of scopes that are blocked from being requested for this
     * auth_provider. If a scope appears in this list, it will not be requested,
     * even if it also appears in `allowedScopes`. `blockedScopes` takes
     * precedence over `allowedScopes`. The number of blocked scopes is limited
     * to 200.
     */
    blockedScopes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Description of the resource.
     * Must be less than 256 characters.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Labels as key value pairs
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location: 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>;
    /**
     * Input only. Represents the workload identity in IAM `principal://` format of the
     * agent(s) that will use this AuthProvider. Example:
     * `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`
     */
    workloadIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=authProvider.d.ts.map