@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
305 lines • 11.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A datastore resource that can be mounted on a privatecloud cluster
*
* ## Example Usage
*
* ### Vmware Engine Datastore Thirdparty
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* // use existing network with connectivity to the thirdparty datastore
* const _default = gcp.compute.getNetwork({
* name: "default",
* });
* // create a thirdparty datastore
* const exampleThirdparty = new gcp.vmwareengine.Datastore("example_thirdparty", {
* name: "thirdparty-datastore",
* location: "us-west1-a",
* description: "example thirdparty datastore.",
* nfsDatastore: {
* thirdPartyFileService: {
* fileShare: "/share1",
* network: _default.then(_default => _default.id),
* servers: ["10.0.0.4"],
* },
* },
* });
* ```
* ### Vmware Engine Datastore Filestore
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* // Use existing filestore instance
* const testInstance = gcp.filestore.getInstance({
* name: "fs-instance",
* location: "",
* });
* // Create a VmwareEngine Datastore, referencing the filestore instance
* const exampleFilestore = new gcp.vmwareengine.Datastore("example_filestore", {
* name: "filestore-datastore",
* location: "",
* description: "example google_file_service.filestore datastore.",
* nfsDatastore: {
* googleFileService: {
* filestoreInstance: testInstanceGoogleFilestoreInstance.id,
* },
* },
* });
* ```
* ### Vmware Engine Datastore Netapp
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* // Use existing netapp volume
* const testVolume = new gcp.netapp.Volume("test_volume", {
* name: "netapp-volume",
* location: "us-west1",
* });
* // Create a VmwareEngine Datastore, referencing the netapp volume
* const exampleNetapp = new gcp.vmwareengine.Datastore("example_netapp", {
* name: "netapp-datastore",
* location: "us-west1",
* description: "example google_file_service.netapp datastore.",
* nfsDatastore: {
* googleFileService: {
* netappVolume: testVolume.id,
* },
* },
* });
* ```
*
* ## Import
*
* Datastore can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/datastores/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Datastore can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:vmwareengine/datastore:Datastore default projects/{{project}}/locations/{{location}}/datastores/{{name}}
* $ pulumi import gcp:vmwareengine/datastore:Datastore default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:vmwareengine/datastore:Datastore default {{location}}/{{name}}
* ```
*/
export declare class Datastore extends pulumi.CustomResource {
/**
* Get an existing Datastore 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?: DatastoreState, opts?: pulumi.CustomResourceOptions): Datastore;
/**
* Returns true if the given object is an instance of Datastore. 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 Datastore;
/**
* Clusters to which the datastore is attached.
*/
readonly clusters: pulumi.Output<string[]>;
/**
* Creation time of this resource.
*/
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>;
/**
* User-provided description for this datastore
*/
readonly description: 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>;
/**
* The user-provided identifier of the datastore to be created.
* This identifier must be unique among each `Datastore` within the parent
* and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
readonly name: pulumi.Output<string>;
/**
* The NFS datastore configuration.
* Structure is documented below.
*/
readonly nfsDatastore: pulumi.Output<outputs.vmwareengine.DatastoreNfsDatastore>;
/**
* 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 state of the Datastore.
* Possible values:
* CREATING
* ACTIVE
* UPDATING
* DELETING
* SOFT_DELETING
* SOFT_DELETED
*/
readonly state: pulumi.Output<string>;
/**
* System-generated unique identifier for the resource.
*/
readonly uid: pulumi.Output<string>;
/**
* Last update time of this resource.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Datastore 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: DatastoreArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Datastore resources.
*/
export interface DatastoreState {
/**
* Clusters to which the datastore is attached.
*/
clusters?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Creation time of this resource.
*/
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>;
/**
* User-provided description for this datastore
*/
description?: 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>;
/**
* The user-provided identifier of the datastore to be created.
* This identifier must be unique among each `Datastore` within the parent
* and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
name?: pulumi.Input<string | undefined>;
/**
* The NFS datastore configuration.
* Structure is documented below.
*/
nfsDatastore?: pulumi.Input<inputs.vmwareengine.DatastoreNfsDatastore | 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 state of the Datastore.
* Possible values:
* CREATING
* ACTIVE
* UPDATING
* DELETING
* SOFT_DELETING
* SOFT_DELETED
*/
state?: pulumi.Input<string | undefined>;
/**
* System-generated unique identifier for the resource.
*/
uid?: pulumi.Input<string | undefined>;
/**
* Last update time of this resource.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Datastore resource.
*/
export interface DatastoreArgs {
/**
* 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-provided description for this datastore
*/
description?: 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 user-provided identifier of the datastore to be created.
* This identifier must be unique among each `Datastore` within the parent
* and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
name?: pulumi.Input<string | undefined>;
/**
* The NFS datastore configuration.
* Structure is documented below.
*/
nfsDatastore: pulumi.Input<inputs.vmwareengine.DatastoreNfsDatastore>;
/**
* 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=datastore.d.ts.map