@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Description * * ## Example Usage * * ### Ces Toolset Openapi Service Account Auth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetOpenapiServiceAccountAuthConfig = new gcp.ces.Toolset("ces_toolset_openapi_service_account_auth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * openApiToolset: { * openApiSchema: `openapi: 3.0.0 * info: * title: My Sample API * version: 1.0.0 * description: A simple API example * servers: * - url: https://api.example.com/v1 * paths: {} * `, * ignoreUnknownFields: false, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * serviceAccountAuthConfig: { * serviceAccount: "my@service-account.com", * scopes: ["scope1"], * }, * }, * }, * }); * ``` * ### Ces Toolset Openapi Oauth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetOpenapiOauthConfig = new gcp.ces.Toolset("ces_toolset_openapi_oauth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * openApiToolset: { * openApiSchema: `openapi: 3.0.0 * info: * title: My Sample API * version: 1.0.0 * description: A simple API example * servers: * - url: https://api.example.com/v1 * paths: {} * `, * ignoreUnknownFields: false, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * oauthConfig: { * oauthGrantType: "CLIENT_CREDENTIAL", * clientId: "example_client_id", * clientSecretVersion: "projects/fake-project/secrets/fake-secret/versions/version1", * tokenEndpoint: "123", * scopes: ["scope1"], * }, * }, * }, * }); * ``` * ### Ces Toolset Openapi Service Agent Id Token Auth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetOpenapiServiceAgentIdTokenAuthConfig = new gcp.ces.Toolset("ces_toolset_openapi_service_agent_id_token_auth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * openApiToolset: { * openApiSchema: `openapi: 3.0.0 * info: * title: My Sample API * version: 1.0.0 * description: A simple API example * servers: * - url: https://api.example.com/v1 * paths: {} * `, * ignoreUnknownFields: false, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * serviceAgentIdTokenAuthConfig: {}, * }, * }, * }); * ``` * ### Ces Toolset Openapi Api Key Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetOpenapiApiKeyConfig = new gcp.ces.Toolset("ces_toolset_openapi_api_key_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * description: "Test description", * executionType: "SYNCHRONOUS", * openApiToolset: { * openApiSchema: `openapi: 3.0.0 * info: * title: My Sample API * version: 1.0.0 * description: A simple API example * servers: * - url: https://api.example.com/v1 * paths: {} * `, * ignoreUnknownFields: false, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * apiKeyConfig: { * keyName: "ExampleKey", * apiKeySecretVersion: "projects/fake-project/secrets/fake-secret/versions/version-1", * requestLocation: "HEADER", * }, * }, * }, * }); * ``` * ### Ces Toolset Bearer Token Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetBearerTokenConfig = new gcp.ces.Toolset("ces_toolset_bearer_token_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * openApiToolset: { * openApiSchema: `openapi: 3.0.0 * info: * title: My Sample API * version: 1.0.0 * description: A simple API example * servers: * - url: https://api.example.com/v1 * paths: {} * `, * ignoreUnknownFields: false, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * bearerTokenConfig: { * token: "$context.variables.my_ces_toolset_auth_token", * }, * }, * }, * }); * ``` * ### Ces Toolset Mcp Service Account Auth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetMcpServiceAccountAuthConfig = new gcp.ces.Toolset("ces_toolset_mcp_service_account_auth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * mcpToolset: { * serverAddress: "https://api.example.com/mcp/", * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * serviceAccountAuthConfig: { * serviceAccount: "my@service-account.com", * scopes: ["scope1"], * }, * }, * }, * }); * ``` * ### Ces Toolset Mcp Oauth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetMcpOauthConfig = new gcp.ces.Toolset("ces_toolset_mcp_oauth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * mcpToolset: { * serverAddress: "https://api.example.com/mcp/", * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * oauthConfig: { * oauthGrantType: "CLIENT_CREDENTIAL", * clientId: "example_client_id", * clientSecretVersion: "projects/fake-project/secrets/fake-secret/versions/version1", * tokenEndpoint: "123", * scopes: ["scope1"], * }, * }, * }, * }); * ``` * ### Ces Toolset Mcp Service Agent Id Token Auth Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetMcpServiceAgentIdTokenAuthConfig = new gcp.ces.Toolset("ces_toolset_mcp_service_agent_id_token_auth_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * mcpToolset: { * serverAddress: "https://api.example.com/mcp/", * customHeaders: { * "X-Custom-Header": "$context.variables.my_variable", * }, * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * serviceAgentIdTokenAuthConfig: {}, * }, * }, * }); * ``` * ### Ces Toolset Mcp Api Key Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetMcpApiKeyConfig = new gcp.ces.Toolset("ces_toolset_mcp_api_key_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * description: "Test description", * executionType: "SYNCHRONOUS", * mcpToolset: { * serverAddress: "https://api.example.com/mcp/", * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * apiKeyConfig: { * keyName: "ExampleKey", * apiKeySecretVersion: "projects/fake-project/secrets/fake-secret/versions/version-1", * requestLocation: "HEADER", * }, * }, * }, * }); * ``` * ### Ces Toolset Mcp Bearer Token Config * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cesAppForToolset = new gcp.ces.App("ces_app_for_toolset", { * appId: "app-id", * location: "us", * description: "App used as parent for CES Toolset example", * displayName: "my-app", * languageSettings: { * defaultLanguageCode: "en-US", * supportedLanguageCodes: [ * "es-ES", * "fr-FR", * ], * enableMultilingualSupport: true, * fallbackAction: "escalate", * }, * timeZoneSettings: { * timeZone: "America/Los_Angeles", * }, * }); * const cesToolsetMcpBearerTokenConfig = new gcp.ces.Toolset("ces_toolset_mcp_bearer_token_config", { * toolsetId: "toolset1", * location: "us", * app: cesAppForToolset.appId, * displayName: "Basic toolset display name", * mcpToolset: { * serverAddress: "https://api.example.com/mcp/", * tlsConfig: { * caCerts: [{ * displayName: "example", * cert: "ZXhhbXBsZQ==", * }], * }, * serviceDirectoryConfig: { * service: "projects/example/locations/us/namespaces/namespace/services/service", * }, * apiAuthentication: { * bearerTokenConfig: { * token: "$context.variables.my_ces_toolset_auth_token", * }, * }, * }, * }); * ``` * * ## Import * * Toolset can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/apps/{{app}}/toolsets/{{toolset_id}}` * * `{{project}}/{{location}}/{{app}}/{{toolset_id}}` * * `{{location}}/{{app}}/{{toolset_id}}` * * When using the `pulumi import` command, Toolset can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:ces/toolset:Toolset default projects/{{project}}/locations/{{location}}/apps/{{app}}/toolsets/{{toolset_id}} * $ pulumi import gcp:ces/toolset:Toolset default {{project}}/{{location}}/{{app}}/{{toolset_id}} * $ pulumi import gcp:ces/toolset:Toolset default {{location}}/{{app}}/{{toolset_id}} * ``` */ export declare class Toolset extends pulumi.CustomResource { /** * Get an existing Toolset 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?: ToolsetState, opts?: pulumi.CustomResourceOptions): Toolset; /** * Returns true if the given object is an instance of Toolset. 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 Toolset; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly app: pulumi.Output<string>; /** * Timestamp when the toolset 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 toolset. */ readonly description: pulumi.Output<string | undefined>; /** * The display name of the toolset. Must be unique within the same app. */ readonly displayName: pulumi.Output<string | undefined>; /** * ETag used to ensure the object hasn't changed during a read-modify-write * operation. If the etag is empty, the update will overwrite any concurrent * changes. */ readonly etag: pulumi.Output<string>; /** * Possible values: * SYNCHRONOUS * ASYNCHRONOUS */ readonly executionType: pulumi.Output<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>; /** * A toolset that contains a list of tools that are offered by the MCP * server. * Structure is documented below. */ readonly mcpToolset: pulumi.Output<outputs.ces.ToolsetMcpToolset | undefined>; /** * Identifier. The unique identifier of the toolset. * Format: * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */ readonly name: pulumi.Output<string>; /** * A toolset that contains a list of tools that are defined by an OpenAPI * schema. * Structure is documented below. */ readonly openApiToolset: pulumi.Output<outputs.ces.ToolsetOpenApiToolset | undefined>; /** * 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 ID to use for the toolset, which will become the final component of * the toolset's resource name. If not provided, a unique ID will be * automatically assigned for the toolset. */ readonly toolsetId: pulumi.Output<string>; /** * Timestamp when the toolset was last updated. */ readonly updateTime: pulumi.Output<string>; /** * Create a Toolset 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: ToolsetArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Toolset resources. */ export interface ToolsetState { /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ app?: pulumi.Input<string | undefined>; /** * Timestamp when the toolset 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 toolset. */ description?: pulumi.Input<string | undefined>; /** * The display name of the toolset. Must be unique within the same app. */ displayName?: pulumi.Input<string | undefined>; /** * ETag used to ensure the object hasn't changed during a read-modify-write * operation. If the etag is empty, the update will overwrite any concurrent * changes. */ etag?: pulumi.Input<string | undefined>; /** * Possible values: * SYNCHRONOUS * ASYNCHRONOUS */ executionType?: 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>; /** * A toolset that contains a list of tools that are offered by the MCP * server. * Structure is documented below. */ mcpToolset?: pulumi.Input<inputs.ces.ToolsetMcpToolset | undefined>; /** * Identifier. The unique identifier of the toolset. * Format: * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` */ name?: pulumi.Input<string | undefined>; /** * A toolset that contains a list of tools that are defined by an OpenAPI * schema. * Structure is documented below. */ openApiToolset?: pulumi.Input<inputs.ces.ToolsetOpenApiToolset | 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 ID to use for the toolset, which will become the final component of * the toolset's resource name. If not provided, a unique ID will be * automatically assigned for the toolset. */ toolsetId?: pulumi.Input<string | undefined>; /** * Timestamp when the toolset was last updated. */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Toolset resource. */ export interface ToolsetArgs { /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ app: 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 toolset. */ description?: pulumi.Input<string | undefined>; /** * The display name of the toolset. Must be unique within the same app. */ displayName?: pulumi.Input<string | undefined>; /** * Possible values: * SYNCHRONOUS * ASYNCHRONOUS */ executionType?: 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>; /** * A toolset that contains a list of tools that are offered by the MCP * server. * Structure is documented below. */ mcpToolset?: pulumi.Input<inputs.ces.ToolsetMcpToolset | undefined>; /** * A toolset that contains a list of tools that are defined by an OpenAPI * schema. * Structure is documented below. */ openApiToolset?: pulumi.Input<inputs.ces.ToolsetOpenApiToolset | 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 ID to use for the toolset, which will become the final component of * the toolset's resource name. If not provided, a unique ID will be * automatically assigned for the toolset. */ toolsetId: pulumi.Input<string>; } //# sourceMappingURL=toolset.d.ts.map