@pulumi/gcp/agentregistry/binding.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";
/**
 * Represents a user-defined Binding.
 *
 * ## Example Usage
 *
 * ### Agent Registry Binding Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as google from "@pulumi/google";
 *
 * const _default = gcp.agentregistry.getAgent({
 *     location: "global",
 *     filter: "displayName:Workspace Agent",
 * });
 * const defaultIamConnectorsConnector = new google.index.IamConnectorsConnector("default", {
 *     location: "us-central1",
 *     connectorId: "ar-binding",
 *     connectorTypeParams: [{
 *         connectorVersion: "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1",
 *     }],
 * });
 * const defaultBinding = new gcp.agentregistry.Binding("default", {
 *     location: "us-central1",
 *     bindingId: "ar-binding",
 *     displayName: "My Binding",
 *     description: "My GA agent registry binding",
 *     source: {
 *         identifier: _default.then(_default => _default.urn),
 *     },
 *     target: {
 *         identifier: _default.then(_default => _default.urn),
 *     },
 *     authProviderBinding: {
 *         authProvider: defaultIamConnectorsConnector.id,
 *         scopes: ["https://www.googleapis.com/auth/cloud-platform"],
 *         continueUri: "https://example.com/continue",
 *     },
 * }, {
 *     dependsOn: [defaultIamConnectorsConnector],
 * });
 * ```
 *
 * ## Import
 *
 * Binding can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/bindings/{{binding_id}}`
 * * `{{project}}/{{location}}/{{binding_id}}`
 * * `{{location}}/{{binding_id}}`
 *
 * When using the `pulumi import` command, Binding can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:agentregistry/binding:Binding default projects/{{project}}/locations/{{location}}/bindings/{{binding_id}}
 * $ pulumi import gcp:agentregistry/binding:Binding default {{project}}/{{location}}/{{binding_id}}
 * $ pulumi import gcp:agentregistry/binding:Binding default {{location}}/{{binding_id}}
 * ```
 */
export declare class Binding extends pulumi.CustomResource {
    /**
     * Get an existing Binding 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?: BindingState, opts?: pulumi.CustomResourceOptions): Binding;
    /**
     * Returns true if the given object is an instance of Binding.  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 Binding;
    /**
     * The auth provider of the Binding.
     * Structure is documented below.
     */
    readonly authProviderBinding: pulumi.Output<outputs.agentregistry.BindingAuthProviderBinding>;
    /**
     * The name of the Binding.
     */
    readonly bindingId: pulumi.Output<string>;
    /**
     * The timestamp when the resource was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * 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>;
    /**
     * The description of the Binding.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * User-defined display name for the Binding.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * The location of the resource.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The resource name of the Binding.
     */
    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 source of the Binding.
     * Structure is documented below.
     */
    readonly source: pulumi.Output<outputs.agentregistry.BindingSource>;
    /**
     * The target of the Binding.
     * Structure is documented below.
     */
    readonly target: pulumi.Output<outputs.agentregistry.BindingTarget>;
    /**
     * The timestamp when the resource was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a Binding 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: BindingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Binding resources.
 */
export interface BindingState {
    /**
     * The auth provider of the Binding.
     * Structure is documented below.
     */
    authProviderBinding?: pulumi.Input<inputs.agentregistry.BindingAuthProviderBinding | undefined>;
    /**
     * The name of the Binding.
     */
    bindingId?: pulumi.Input<string | undefined>;
    /**
     * The timestamp when the resource was created.
     */
    createTime?: 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>;
    /**
     * The description of the Binding.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User-defined display name for the Binding.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The location of the resource.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The resource name of the Binding.
     */
    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 source of the Binding.
     * Structure is documented below.
     */
    source?: pulumi.Input<inputs.agentregistry.BindingSource | undefined>;
    /**
     * The target of the Binding.
     * Structure is documented below.
     */
    target?: pulumi.Input<inputs.agentregistry.BindingTarget | undefined>;
    /**
     * The timestamp when the resource was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Binding resource.
 */
export interface BindingArgs {
    /**
     * The auth provider of the Binding.
     * Structure is documented below.
     */
    authProviderBinding: pulumi.Input<inputs.agentregistry.BindingAuthProviderBinding>;
    /**
     * The name of the Binding.
     */
    bindingId: pulumi.Input<string>;
    /**
     * 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>;
    /**
     * The description of the Binding.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User-defined display name for the Binding.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * The location of the resource.
     */
    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>;
    /**
     * The source of the Binding.
     * Structure is documented below.
     */
    source: pulumi.Input<inputs.agentregistry.BindingSource>;
    /**
     * The target of the Binding.
     * Structure is documented below.
     */
    target: pulumi.Input<inputs.agentregistry.BindingTarget>;
}
//# sourceMappingURL=binding.d.ts.map