Docs Home
Google Cloud v8.41.1 published on Monday, Aug 25, 2025 by Pulumi
gcp.vertex.AiRagEngineConfig
Explore with Pulumi AI
Vertex AI RAG Engine lets you scale your RagManagedDb instance based on your usage and performance requirements using a choice of two tiers, and optionally, lets you delete your Vertex AI RAG Engine data using a third tier. The tier is a project-level setting that’s available in the RagEngineConfig resource that impacts all RAG corpora using RagManagedDb. The following tiers are available in RagEngineConfig: Basic, Scaled and Unprovisioned.
To get more information about RagEngineConfig, see:
- API documentation
- How-to Guides
Example Usage
Create AiRagEngineConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiRagEngineConfig(name: string, args: AiRagEngineConfigArgs, opts?: CustomResourceOptions);@overload
def AiRagEngineConfig(resource_name: str,
args: AiRagEngineConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AiRagEngineConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
rag_managed_db_config: Optional[AiRagEngineConfigRagManagedDbConfigArgs] = None,
project: Optional[str] = None,
region: Optional[str] = None)func NewAiRagEngineConfig(ctx *Context, name string, args AiRagEngineConfigArgs, opts ...ResourceOption) (*AiRagEngineConfig, error)public AiRagEngineConfig(string name, AiRagEngineConfigArgs args, CustomResourceOptions? opts = null)
public AiRagEngineConfig(String name, AiRagEngineConfigArgs args)
public AiRagEngineConfig(String name, AiRagEngineConfigArgs args, CustomResourceOptions options)
type: gcp:vertex:AiRagEngineConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AiRagEngineConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AiRagEngineConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AiRagEngineConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiRagEngineConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiRagEngineConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var aiRagEngineConfigResource = new Gcp.Vertex.AiRagEngineConfig("aiRagEngineConfigResource", new()
{
RagManagedDbConfig = new Gcp.Vertex.Inputs.AiRagEngineConfigRagManagedDbConfigArgs
{
Basic = null,
Scaled = null,
Unprovisioned = null,
},
Project = "string",
Region = "string",
});
example, err := vertex.NewAiRagEngineConfig(ctx, "aiRagEngineConfigResource", &vertex.AiRagEngineConfigArgs{
RagManagedDbConfig: &vertex.AiRagEngineConfigRagManagedDbConfigArgs{
Basic: &vertex.AiRagEngineConfigRagManagedDbConfigBasicArgs{},
Scaled: &vertex.AiRagEngineConfigRagManagedDbConfigScaledArgs{},
Unprovisioned: &vertex.AiRagEngineConfigRagManagedDbConfigUnprovisionedArgs{},
},
Project: pulumi.String("string"),
Region: pulumi.String("string"),
})
var aiRagEngineConfigResource = new AiRagEngineConfig("aiRagEngineConfigResource", AiRagEngineConfigArgs.builder()
.ragManagedDbConfig(AiRagEngineConfigRagManagedDbConfigArgs.builder()
.basic(AiRagEngineConfigRagManagedDbConfigBasicArgs.builder()
.build())
.scaled(AiRagEngineConfigRagManagedDbConfigScaledArgs.builder()
.build())
.unprovisioned(AiRagEngineConfigRagManagedDbConfigUnprovisionedArgs.builder()
.build())
.build())
.project("string")
.region("string")
.build());
ai_rag_engine_config_resource = gcp.vertex.AiRagEngineConfig("aiRagEngineConfigResource",
rag_managed_db_config={
"basic": {},
"scaled": {},
"unprovisioned": {},
},
project="string",
region="string")
const aiRagEngineConfigResource = new gcp.vertex.AiRagEngineConfig("aiRagEngineConfigResource", {
ragManagedDbConfig: {
basic: {},
scaled: {},
unprovisioned: {},
},
project: "string",
region: "string",
});
type: gcp:vertex:AiRagEngineConfig
properties:
project: string
ragManagedDbConfig:
basic: {}
scaled: {}
unprovisioned: {}
region: string
AiRagEngineConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AiRagEngineConfig resource accepts the following input properties:
- Rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
- The region of the RagEngineConfig. eg us-central1
- Rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config Args - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
- The region of the RagEngineConfig. eg us-central1
- rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
- The region of the RagEngineConfig. eg us-central1
- rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
- The region of the RagEngineConfig. eg us-central1
- rag_
managed_ Aidb_ config Rag Engine Config Rag Managed Db Config Args - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
- The region of the RagEngineConfig. eg us-central1
- rag
Managed Property MapDb Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
- The region of the RagEngineConfig. eg us-central1
Outputs
All input properties are implicitly available as output properties. Additionally, the AiRagEngineConfig resource produces the following output properties:
Look up Existing AiRagEngineConfig Resource
Get an existing AiRagEngineConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AiRagEngineConfigState, opts?: CustomResourceOptions): AiRagEngineConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
project: Optional[str] = None,
rag_managed_db_config: Optional[AiRagEngineConfigRagManagedDbConfigArgs] = None,
region: Optional[str] = None) -> AiRagEngineConfigfunc GetAiRagEngineConfig(ctx *Context, name string, id IDInput, state *AiRagEngineConfigState, opts ...ResourceOption) (*AiRagEngineConfig, error)public static AiRagEngineConfig Get(string name, Input<string> id, AiRagEngineConfigState? state, CustomResourceOptions? opts = null)public static AiRagEngineConfig get(String name, Output<String> id, AiRagEngineConfigState state, CustomResourceOptions options)resources: _: type: gcp:vertex:AiRagEngineConfig get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Name string
- The resource name of the Dataset. This value is set by Google.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- Region string
- The region of the RagEngineConfig. eg us-central1
- Name string
- The resource name of the Dataset. This value is set by Google.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config Args - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- Region string
- The region of the RagEngineConfig. eg us-central1
- name String
- The resource name of the Dataset. This value is set by Google.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- region String
- The region of the RagEngineConfig. eg us-central1
- name string
- The resource name of the Dataset. This value is set by Google.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rag
Managed AiDb Config Rag Engine Config Rag Managed Db Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- region string
- The region of the RagEngineConfig. eg us-central1
- name str
- The resource name of the Dataset. This value is set by Google.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rag_
managed_ Aidb_ config Rag Engine Config Rag Managed Db Config Args - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- region str
- The region of the RagEngineConfig. eg us-central1
- name String
- The resource name of the Dataset. This value is set by Google.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- rag
Managed Property MapDb Config - Required. The config of the RagManagedDb used by RagEngine. Structure is documented below.
- region String
- The region of the RagEngineConfig. eg us-central1
Supporting Types
AiRagEngineConfigRagManagedDbConfig, AiRagEngineConfigRagManagedDbConfigArgs
- Basic
Ai
Rag Engine Config Rag Managed Db Config Basic - Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- Scaled
Ai
Rag Engine Config Rag Managed Db Config Scaled - Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- Unprovisioned
Ai
Rag Engine Config Rag Managed Db Config Unprovisioned - Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
- Basic
Ai
Rag Engine Config Rag Managed Db Config Basic - Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- Scaled
Ai
Rag Engine Config Rag Managed Db Config Scaled - Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- Unprovisioned
Ai
Rag Engine Config Rag Managed Db Config Unprovisioned - Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
- basic
Ai
Rag Engine Config Rag Managed Db Config Basic - Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- scaled
Ai
Rag Engine Config Rag Managed Db Config Scaled - Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- unprovisioned
Ai
Rag Engine Config Rag Managed Db Config Unprovisioned - Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
- basic
Ai
Rag Engine Config Rag Managed Db Config Basic - Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- scaled
Ai
Rag Engine Config Rag Managed Db Config Scaled - Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- unprovisioned
Ai
Rag Engine Config Rag Managed Db Config Unprovisioned - Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
- basic
Ai
Rag Engine Config Rag Managed Db Config Basic - Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- scaled
Ai
Rag Engine Config Rag Managed Db Config Scaled - Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- unprovisioned
Ai
Rag Engine Config Rag Managed Db Config Unprovisioned - Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
- basic Property Map
- Basic tier is a cost-effective and low compute tier suitable for the following cases: Experimenting with RagManagedDb, Small data size, Latency insensitive workload, Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen.
- scaled Property Map
- Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.
- unprovisioned Property Map
- Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.
Import
RagEngineConfig can be imported using any of these accepted formats:
projects/{{project}}/locations/{{region}}/ragEngineConfig{{project}}/{{region}}{{region}}
When using the pulumi import command, RagEngineConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:vertex/aiRagEngineConfig:AiRagEngineConfig default projects/{{project}}/locations/{{region}}/ragEngineConfig
$ pulumi import gcp:vertex/aiRagEngineConfig:AiRagEngineConfig default {{project}}/{{region}}
$ pulumi import gcp:vertex/aiRagEngineConfig:AiRagEngineConfig default {{region}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.