@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
436 lines • 17.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* AgentGateway represents the agent gateway resource.
*
* To get more information about AgentGateway, see:
*
* * [API documentation](https://cloud.google.com/network-services/docs/reference/network-services/rest/v1/projects.locations.agentGateways)
*
* ## Example Usage
*
* ### Network Services Agent Gateway Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const agentRegistry = new gcp.projects.Service("agent_registry", {
* service: "agentregistry.googleapis.com",
* disableOnDestroy: false,
* });
* const defaultNetwork = new gcp.compute.Network("default", {
* name: "my-gateway-network",
* autoCreateSubnetworks: false,
* });
* const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
* name: "my-gateway-subnetwork",
* region: "us-central1",
* network: defaultNetwork.id,
* ipCidrRange: "10.0.0.0/16",
* });
* const defaultNetworkAttachment = new gcp.compute.NetworkAttachment("default", {
* name: "my-gateway-attachment",
* region: "us-central1",
* connectionPreference: "ACCEPT_MANUAL",
* subnetworks: [defaultSubnetwork.id],
* });
* const defaultManagedZone = new gcp.dns.ManagedZone("default", {
* name: "my-gateway-zone",
* dnsName: "example.com.",
* description: "Private zone used by AgentGateway DNS peering",
* visibility: "private",
* privateVisibilityConfig: {
* networks: [{
* networkUrl: defaultNetwork.id,
* }],
* },
* });
* const _default = new gcp.networkservices.AgentGateway("default", {
* name: "my-full-agent-gateway",
* location: "us-central1",
* description: "A full configuration for Agent Gateway",
* labels: {
* env: "test",
* tier: "gold",
* },
* protocols: ["MCP"],
* googleManaged: {
* governedAccessPath: "AGENT_TO_ANYWHERE",
* },
* registries: ["//agentregistry.googleapis.com/projects/my-project-name/locations/us-central1"],
* networkConfig: {
* egress: {
* networkAttachment: defaultNetworkAttachment.id,
* },
* dnsPeeringConfig: {
* domains: [defaultManagedZone.dnsName],
* targetProject: project.then(project => project.projectId),
* targetNetwork: defaultNetwork.id,
* },
* },
* }, {
* dependsOn: [agentRegistry],
* });
* ```
* ### Network Services Agent Gateway Client To Agent
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const agentRegistry = new gcp.projects.Service("agent_registry", {
* service: "agentregistry.googleapis.com",
* disableOnDestroy: false,
* });
* const _default = new gcp.networkservices.AgentGateway("default", {
* name: "my-client-to-agent-gateway",
* location: "us-central1",
* googleManaged: {
* governedAccessPath: "CLIENT_TO_AGENT",
* },
* registries: ["//agentregistry.googleapis.com/projects/my-project-name/locations/us-central1"],
* }, {
* dependsOn: [agentRegistry],
* });
* ```
* ### Network Services Agent Gateway Self Managed
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networkservices.AgentGateway("default", {
* name: "my-self-managed-agent-gateway",
* location: "us-central1",
* selfManaged: {
* resourceUri: "projects/my-project-name/locations/us-central1/gateways/my-gateway",
* },
* registries: ["//agentregistry.googleapis.com/projects/my-project-name/locations/us-central1"],
* });
* ```
*
* ## Import
*
* AgentGateway can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/agentGateways/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, AgentGateway can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/agentGateway:AgentGateway default projects/{{project}}/locations/{{location}}/agentGateways/{{name}}
* $ pulumi import gcp:networkservices/agentGateway:AgentGateway default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:networkservices/agentGateway:AgentGateway default {{location}}/{{name}}
* ```
*/
export declare class AgentGateway extends pulumi.CustomResource {
/**
* Get an existing AgentGateway 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?: AgentGatewayState, opts?: pulumi.CustomResourceOptions): AgentGateway;
/**
* Returns true if the given object is an instance of AgentGateway. 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 AgentGateway;
/**
* AgentGatewayOutputCard contains informational output-only fields.
* Structure is documented below.
*/
readonly agentGatewayCards: pulumi.Output<outputs.networkservices.AgentGatewayAgentGatewayCard[]>;
/**
* 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>;
/**
* A free-text description of the resource. Max length 1024 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;
}>;
/**
* Etag of the resource.
* If this is provided, it must match the server's etag. If the provided etag
* does not match the server's etag, the request will fail with a 409 ABORTED
* error.
*/
readonly etag: pulumi.Output<string>;
/**
* Configuration for Google Managed deployment mode.
* Proxy is orchestrated and managed by GoogleCloud in a tenant project.
* Structure is documented below.
*/
readonly googleManaged: pulumi.Output<outputs.networkservices.AgentGatewayGoogleManaged | undefined>;
/**
* Set of label tags associated with the AgentGateway resource.
*
* **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>;
/**
* The location of the agent gateway.
*/
readonly location: pulumi.Output<string>;
/**
* Name of the AgentGateway resource.
*/
readonly name: pulumi.Output<string>;
/**
* Network configuration for the AgentGateway.
* Structure is documented below.
*/
readonly networkConfig: pulumi.Output<outputs.networkservices.AgentGatewayNetworkConfig | 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>;
/**
* (Optional, Deprecated)
* List of protocols supported by an Agent Gateway.
* Each value may be one of: `MCP`.
*
* > **Warning:** `protocols` is deprecated and will be removed in a future major release.
*
* @deprecated `protocols` is deprecated and will be removed in a future major release.
*/
readonly protocols: pulumi.Output<string[] | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway.
* Note: Currently limited to project-scoped registries Must be of format
* `//agentregistry.googleapis.com/{version}/projects/{{project}}/locations/{{location}}`
*/
readonly registries: pulumi.Output<string[] | undefined>;
/**
* Configuration for Self Managed deployment mode.
* Attach to existing Application Load Balancers or Secure Web Proxies.
* Structure is documented below.
*/
readonly selfManaged: pulumi.Output<outputs.networkservices.AgentGatewaySelfManaged | undefined>;
/**
* The timestamp when the resource was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a AgentGateway 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: AgentGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AgentGateway resources.
*/
export interface AgentGatewayState {
/**
* AgentGatewayOutputCard contains informational output-only fields.
* Structure is documented below.
*/
agentGatewayCards?: pulumi.Input<pulumi.Input<inputs.networkservices.AgentGatewayAgentGatewayCard>[] | 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>;
/**
* A free-text description of the resource. Max length 1024 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>;
/**
* Etag of the resource.
* If this is provided, it must match the server's etag. If the provided etag
* does not match the server's etag, the request will fail with a 409 ABORTED
* error.
*/
etag?: pulumi.Input<string | undefined>;
/**
* Configuration for Google Managed deployment mode.
* Proxy is orchestrated and managed by GoogleCloud in a tenant project.
* Structure is documented below.
*/
googleManaged?: pulumi.Input<inputs.networkservices.AgentGatewayGoogleManaged | undefined>;
/**
* Set of label tags associated with the AgentGateway resource.
*
* **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>;
/**
* The location of the agent gateway.
*/
location?: pulumi.Input<string | undefined>;
/**
* Name of the AgentGateway resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* Network configuration for the AgentGateway.
* Structure is documented below.
*/
networkConfig?: pulumi.Input<inputs.networkservices.AgentGatewayNetworkConfig | 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>;
/**
* (Optional, Deprecated)
* List of protocols supported by an Agent Gateway.
* Each value may be one of: `MCP`.
*
* > **Warning:** `protocols` is deprecated and will be removed in a future major release.
*
* @deprecated `protocols` is deprecated and will be removed in a future major release.
*/
protocols?: pulumi.Input<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>;
/**
* A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway.
* Note: Currently limited to project-scoped registries Must be of format
* `//agentregistry.googleapis.com/{version}/projects/{{project}}/locations/{{location}}`
*/
registries?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Configuration for Self Managed deployment mode.
* Attach to existing Application Load Balancers or Secure Web Proxies.
* Structure is documented below.
*/
selfManaged?: pulumi.Input<inputs.networkservices.AgentGatewaySelfManaged | undefined>;
/**
* The timestamp when the resource was updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a AgentGateway resource.
*/
export interface AgentGatewayArgs {
/**
* 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>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* Configuration for Google Managed deployment mode.
* Proxy is orchestrated and managed by GoogleCloud in a tenant project.
* Structure is documented below.
*/
googleManaged?: pulumi.Input<inputs.networkservices.AgentGatewayGoogleManaged | undefined>;
/**
* Set of label tags associated with the AgentGateway resource.
*
* **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>;
/**
* The location of the agent gateway.
*/
location: pulumi.Input<string>;
/**
* Name of the AgentGateway resource.
*/
name?: pulumi.Input<string | undefined>;
/**
* Network configuration for the AgentGateway.
* Structure is documented below.
*/
networkConfig?: pulumi.Input<inputs.networkservices.AgentGatewayNetworkConfig | 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>;
/**
* (Optional, Deprecated)
* List of protocols supported by an Agent Gateway.
* Each value may be one of: `MCP`.
*
* > **Warning:** `protocols` is deprecated and will be removed in a future major release.
*
* @deprecated `protocols` is deprecated and will be removed in a future major release.
*/
protocols?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway.
* Note: Currently limited to project-scoped registries Must be of format
* `//agentregistry.googleapis.com/{version}/projects/{{project}}/locations/{{location}}`
*/
registries?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Configuration for Self Managed deployment mode.
* Attach to existing Application Load Balancers or Secure Web Proxies.
* Structure is documented below.
*/
selfManaged?: pulumi.Input<inputs.networkservices.AgentGatewaySelfManaged | undefined>;
}
//# sourceMappingURL=agentGateway.d.ts.map