@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; /** * In Cloud Firestore, the unit of storage is the document. A document is a lightweight record * that contains fields, which map to values. Each document is identified by a name. * * To get more information about Document, see: * * * [API documentation](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) * * How-to Guides * * [Official Documentation](https://cloud.google.com/firestore/docs/manage-data/add-data) * * > **Warning:** This resource creates a Firestore Document on a project that already has * a Firestore database. If you haven't already created it, you may * create a `gcp.firestore.Database` resource with `type` set to * `"FIRESTORE_NATIVE"` and `locationId` set to your chosen location. * If you wish to use App Engine, you may instead create a * `gcp.appengine.Application` resource with `databaseType` set to * `"CLOUD_FIRESTORE"`. Your Firestore location will be the same as * the App Engine location specified. * * ## Example Usage * * ### Firestore Document Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as time from "@pulumiverse/time"; * * const project = new gcp.organizations.Project("project", { * projectId: "project-id", * name: "project-id", * orgId: "123456789", * deletionPolicy: "DELETE", * }); * const wait60Seconds = new time.Sleep("wait_60_seconds", {createDuration: "60s"}, { * dependsOn: [project], * }); * const firestore = new gcp.projects.Service("firestore", { * project: project.projectId, * service: "firestore.googleapis.com", * }, { * dependsOn: [wait60Seconds], * }); * const database = new gcp.firestore.Database("database", { * project: project.projectId, * name: "(default)", * locationId: "nam5", * type: "FIRESTORE_NATIVE", * }, { * dependsOn: [firestore], * }); * const mydoc = new gcp.firestore.Document("mydoc", { * project: project.projectId, * database: database.name, * collection: "somenewcollection", * documentId: "my-doc-id", * fields: "{\"something\":{\"mapValue\":{\"fields\":{\"akey\":{\"stringValue\":\"avalue\"}}}}}", * }); * ``` * ### Firestore Document Nested Document * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as time from "@pulumiverse/time"; * * const project = new gcp.organizations.Project("project", { * projectId: "project-id", * name: "project-id", * orgId: "123456789", * deletionPolicy: "DELETE", * }); * const wait60Seconds = new time.Sleep("wait_60_seconds", {createDuration: "60s"}, { * dependsOn: [project], * }); * const firestore = new gcp.projects.Service("firestore", { * project: project.projectId, * service: "firestore.googleapis.com", * }, { * dependsOn: [wait60Seconds], * }); * const database = new gcp.firestore.Database("database", { * project: project.projectId, * name: "(default)", * locationId: "nam5", * type: "FIRESTORE_NATIVE", * }, { * dependsOn: [firestore], * }); * const mydoc = new gcp.firestore.Document("mydoc", { * project: project.projectId, * database: database.name, * collection: "somenewcollection", * documentId: "my-doc-id", * fields: "{\"something\":{\"mapValue\":{\"fields\":{\"akey\":{\"stringValue\":\"avalue\"}}}}}", * }); * const subDocument = new gcp.firestore.Document("sub_document", { * project: project.projectId, * database: database.name, * collection: pulumi.interpolate`${mydoc.path}/subdocs`, * documentId: "bitcoinkey", * fields: "{\"something\":{\"mapValue\":{\"fields\":{\"ayo\":{\"stringValue\":\"val2\"}}}}}", * }); * const subSubDocument = new gcp.firestore.Document("sub_sub_document", { * project: project.projectId, * database: database.name, * collection: pulumi.interpolate`${subDocument.path}/subsubdocs`, * documentId: "asecret", * fields: "{\"something\":{\"mapValue\":{\"fields\":{\"secret\":{\"stringValue\":\"hithere\"}}}}}", * }); * ``` * * ## Import * * Document can be imported using any of these accepted formats: * * * `{{name}}` * * When using the `pulumi import` command, Document can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:firestore/document:Document default {{name}} * ``` */ export declare class Document extends pulumi.CustomResource { /** * Get an existing Document 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?: DocumentState, opts?: pulumi.CustomResourceOptions): Document; /** * Returns true if the given object is an instance of Document. 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 Document; /** * The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. */ readonly collection: pulumi.Output<string>; /** * Creation timestamp in RFC3339 format. */ readonly createTime: pulumi.Output<string>; /** * The Firestore database id. Defaults to `"(default)"`. */ readonly database: 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>; /** * The client-assigned document ID to use for this document during creation. */ readonly documentId: pulumi.Output<string>; /** * The document's [fields](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) formated as a json string. */ readonly fields: pulumi.Output<string>; /** * A server defined name for this document. Format: * `projects/{{project_id}}/databases/{{database_id}}/documents/{{path}}/{{document_id}}` */ readonly name: pulumi.Output<string>; /** * A relative path to the collection this document exists within */ readonly path: 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>; /** * Last update timestamp in RFC3339 format. */ readonly updateTime: pulumi.Output<string>; /** * Create a Document 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: DocumentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Document resources. */ export interface DocumentState { /** * The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. */ collection?: pulumi.Input<string | undefined>; /** * Creation timestamp in RFC3339 format. */ createTime?: pulumi.Input<string | undefined>; /** * The Firestore database id. Defaults to `"(default)"`. */ database?: 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 client-assigned document ID to use for this document during creation. */ documentId?: pulumi.Input<string | undefined>; /** * The document's [fields](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) formated as a json string. */ fields?: pulumi.Input<string | undefined>; /** * A server defined name for this document. Format: * `projects/{{project_id}}/databases/{{database_id}}/documents/{{path}}/{{document_id}}` */ name?: pulumi.Input<string | undefined>; /** * A relative path to the collection this document exists within */ path?: 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>; /** * Last update timestamp in RFC3339 format. */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Document resource. */ export interface DocumentArgs { /** * The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. */ collection: pulumi.Input<string>; /** * The Firestore database id. Defaults to `"(default)"`. */ database?: 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 client-assigned document ID to use for this document during creation. */ documentId: pulumi.Input<string>; /** * The document's [fields](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) formated as a json string. */ fields: 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>; } //# sourceMappingURL=document.d.ts.map