@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
396 lines • 15.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Description
*
* ## Example Usage
*
* ### Vectorsearch Collection Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example_collection = new gcp.vectorsearch.Collection("example-collection", {
* location: "us-central1",
* collectionId: "example-collection",
* displayName: "My Awesome Collection",
* description: "This collection stores important data.",
* labels: {
* env: "dev",
* team: "my-team",
* },
* dataSchema: `{
* \\"type\\": \\"object\\",
* \\"properties\\": {
* \\"title\\": {
* \\"type\\": \\"string\\"
* },
* \\"plot\\": {
* \\"type\\": \\"string\\"
* }
* }
* }
* `,
* vectorSchemas: [{
* fieldName: "text_embedding",
* denseVector: {
* dimensions: 768,
* vertexEmbeddingConfig: {
* modelId: "textembedding-gecko@003",
* taskType: "RETRIEVAL_DOCUMENT",
* textTemplate: "Title: {title} ---- Plot: {plot}",
* },
* },
* }],
* });
* ```
* ### Vectorsearch Collection Cmek
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const keyRing = new gcp.kms.KeyRing("key_ring", {
* name: "example-cmek-collection",
* location: "us-central1",
* });
* const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
* name: "example-cmek-collection",
* keyRing: keyRing.id,
* });
* const project = gcp.organizations.getProject({});
* const cryptoKeyMemberVsSa = new gcp.kms.CryptoKeyIAMMember("crypto_key_member_vs_sa", {
* cryptoKeyId: cryptoKey.id,
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-vectorsearch.iam.gserviceaccount.com`),
* });
* const example_cmek_collection = new gcp.vectorsearch.Collection("example-cmek-collection", {
* location: "us-central1",
* collectionId: "example-cmek-collection",
* displayName: "My Awesome Encrypted Collection",
* description: "This collection stores important data.",
* encryptionSpec: {
* cryptoKeyName: cryptoKey.id,
* },
* labels: {
* env: "dev",
* team: "my-team",
* },
* dataSchema: `{
* \\"type\\": \\"object\\",
* \\"properties\\": {
* \\"title\\": {
* \\"type\\": \\"string\\"
* },
* \\"plot\\": {
* \\"type\\": \\"string\\"
* }
* }
* }
* `,
* vectorSchemas: [{
* fieldName: "text_embedding",
* denseVector: {
* dimensions: 768,
* vertexEmbeddingConfig: {
* modelId: "textembedding-gecko@003",
* taskType: "RETRIEVAL_DOCUMENT",
* textTemplate: "Title: {title} ---- Plot: {plot}",
* },
* },
* }],
* }, {
* dependsOn: [cryptoKeyMemberVsSa],
* });
* ```
*
* ## Import
*
* Collection can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/collections/{{collection_id}}`
* * `{{project}}/{{location}}/{{collection_id}}`
* * `{{location}}/{{collection_id}}`
*
* When using the `pulumi import` command, Collection can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:vectorsearch/collection:Collection default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}
* $ pulumi import gcp:vectorsearch/collection:Collection default {{project}}/{{location}}/{{collection_id}}
* $ pulumi import gcp:vectorsearch/collection:Collection default {{location}}/{{collection_id}}
* ```
*/
export declare class Collection extends pulumi.CustomResource {
/**
* Get an existing Collection 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?: CollectionState, opts?: pulumi.CustomResourceOptions): Collection;
/**
* Returns true if the given object is an instance of Collection. 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 Collection;
/**
* ID of the Collection to create.
* The id must be 1-63 characters long, and comply with
* [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
* Specifically, it must be 1-63 characters long and match the regular
* expression `a-z?`.
*/
readonly collectionId: pulumi.Output<string>;
/**
* [Output only] Create time stamp
*/
readonly createTime: pulumi.Output<string>;
/**
* JSON Schema for data.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
*/
readonly dataSchema: pulumi.Output<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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* User-specified description of the collection
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User-specified display name of the collection
*/
readonly displayName: 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;
}>;
/**
* Represents a customer-managed encryption key specification that can be
* applied to a Vector Search collection.
* Structure is documented below.
*/
readonly encryptionSpec: pulumi.Output<outputs.vectorsearch.CollectionEncryptionSpec | 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.
*/
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. name of resource
*/
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;
}>;
/**
* [Output only] Update time stamp
*/
readonly updateTime: pulumi.Output<string>;
/**
* Schema for vector fields. Only vector fields in this schema will be
* searchable.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
* Structure is documented below.
*/
readonly vectorSchemas: pulumi.Output<outputs.vectorsearch.CollectionVectorSchema[] | undefined>;
/**
* Create a Collection 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: CollectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Collection resources.
*/
export interface CollectionState {
/**
* ID of the Collection to create.
* The id must be 1-63 characters long, and comply with
* [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
* Specifically, it must be 1-63 characters long and match the regular
* expression `a-z?`.
*/
collectionId?: pulumi.Input<string | undefined>;
/**
* [Output only] Create time stamp
*/
createTime?: pulumi.Input<string | undefined>;
/**
* JSON Schema for data.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
*/
dataSchema?: 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>;
/**
* User-specified description of the collection
*/
description?: pulumi.Input<string | undefined>;
/**
* User-specified display name of the collection
*/
displayName?: 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>;
/**
* Represents a customer-managed encryption key specification that can be
* applied to a Vector Search collection.
* Structure is documented below.
*/
encryptionSpec?: pulumi.Input<inputs.vectorsearch.CollectionEncryptionSpec | 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. name of resource
*/
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>;
/**
* [Output only] Update time stamp
*/
updateTime?: pulumi.Input<string | undefined>;
/**
* Schema for vector fields. Only vector fields in this schema will be
* searchable.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
* Structure is documented below.
*/
vectorSchemas?: pulumi.Input<pulumi.Input<inputs.vectorsearch.CollectionVectorSchema>[] | undefined>;
}
/**
* The set of arguments for constructing a Collection resource.
*/
export interface CollectionArgs {
/**
* ID of the Collection to create.
* The id must be 1-63 characters long, and comply with
* [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
* Specifically, it must be 1-63 characters long and match the regular
* expression `a-z?`.
*/
collectionId: pulumi.Input<string>;
/**
* JSON Schema for data.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
*/
dataSchema?: 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>;
/**
* User-specified description of the collection
*/
description?: pulumi.Input<string | undefined>;
/**
* User-specified display name of the collection
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Represents a customer-managed encryption key specification that can be
* applied to a Vector Search collection.
* Structure is documented below.
*/
encryptionSpec?: pulumi.Input<inputs.vectorsearch.CollectionEncryptionSpec | 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>;
/**
* Schema for vector fields. Only vector fields in this schema will be
* searchable.
* Field names must contain only alphanumeric characters,
* underscores, and hyphens.
* Structure is documented below.
*/
vectorSchemas?: pulumi.Input<pulumi.Input<inputs.vectorsearch.CollectionVectorSchema>[] | undefined>;
}
//# sourceMappingURL=collection.d.ts.map