@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
520 lines • 21.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A Managed Lustre instance
*
* To get more information about Instance, see:
*
* * [API documentation](https://cloud.google.com/managed-lustre/docs/reference/rest/v1/projects.locations.instances)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/managed-lustre/docs/create-instance)
*
* ## Example Usage
*
* ### Lustre Instance Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* // This example assumes this network already exists.
* // The API creates a tenant network per network authorized for a
* // Lustre instance and that network is not deleted when the user-created
* // network (authorized_network) is deleted, so this prevents issues
* // with tenant network quota.
* // If this network hasn't been created and you are using this example in your
* // config, add an additional network resource or change
* // this from "data"to "resource"
* const lustre_network = gcp.compute.getNetwork({
* name: "my-network",
* });
* const instance = new gcp.lustre.Instance("instance", {
* instanceId: "my-instance",
* location: "us-central1-a",
* description: "test lustre instance",
* filesystem: "testfs",
* capacityGib: "18000",
* network: lustre_network.then(lustre_network => lustre_network.id),
* perUnitStorageThroughput: "1000",
* labels: {
* test: "value",
* },
* });
* ```
*
* ## Import
*
* Instance can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance_id}}`
* * `{{project}}/{{location}}/{{instance_id}}`
* * `{{location}}/{{instance_id}}`
*
* When using the `pulumi import` command, Instance can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:lustre/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{instance_id}}
* $ pulumi import gcp:lustre/instance:Instance default {{project}}/{{location}}/{{instance_id}}
* $ pulumi import gcp:lustre/instance:Instance default {{location}}/{{instance_id}}
* ```
*/
export declare class Instance extends pulumi.CustomResource {
/**
* Get an existing Instance 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?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance;
/**
* Returns true if the given object is an instance of Instance. 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 Instance;
/**
* IP-based access rules for the Managed Lustre instance. These options
* define the root user squash configuration.
* Structure is documented below.
*/
readonly accessRulesOptions: pulumi.Output<outputs.lustre.InstanceAccessRulesOptions | undefined>;
/**
* The storage capacity of the instance in gibibytes (GiB). Allowed values
* are from `9000` to `7632000`, depending on the `perUnitStorageThroughput`.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for specific minimums, maximums, and step sizes for each performance tier.
*/
readonly capacityGib: pulumi.Output<string>;
/**
* Timestamp when the instance 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 user-readable description of the instance.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Dynamic tier options for a Managed Lustre instance.
* Structure is documented below.
*/
readonly dynamicTierOptions: pulumi.Output<outputs.lustre.InstanceDynamicTierOptions | 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;
}>;
/**
* The filesystem name for this instance. This name is used by client-side
* tools, including when mounting the instance. Must be eight characters or
* less and can only contain letters and numbers.
*/
readonly filesystem: pulumi.Output<string>;
/**
* Indicates whether you want to enable support for GKE clients. By default,
* GKE clients are not supported.
*/
readonly gkeSupportEnabled: pulumi.Output<boolean | undefined>;
/**
* The name of the Managed Lustre instance.
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
*/
readonly instanceId: pulumi.Output<string>;
/**
* The Cloud KMS key name to use for data encryption.
* If not set, the instance will use Google-managed encryption keys.
* If set, the instance will use customer-managed encryption keys.
* The key must be in the same region as the instance.
* The key format is:
* projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
*/
readonly kmsKey: pulumi.Output<string | 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>;
/**
* Defines a maintenance policy for a resource.
* Structure is documented below.
*/
readonly maintenancePolicy: pulumi.Output<outputs.lustre.InstanceMaintenancePolicy | undefined>;
/**
* Mount point of the instance in the format `IP_ADDRESS@tcp:/FILESYSTEM`.
*/
readonly mountPoint: pulumi.Output<string>;
/**
* Identifier. The name of the instance.
*/
readonly name: pulumi.Output<string>;
/**
* The full name of the VPC network to which the instance is connected.
* Must be in the format
* `projects/{project_id}/global/networks/{network_name}`.
*/
readonly network: pulumi.Output<string>;
/**
* The throughput of the instance in MBps per TiB. Valid values are 125, 250,
* 500, 1000.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for more information.
* If the instance is using the Dynamic tier, this field must not be set or
* must be set to zero.
*/
readonly perUnitStorageThroughput: pulumi.Output<string | undefined>;
/**
* The placement policy name for the instance in the format of
* projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
*/
readonly placementPolicy: pulumi.Output<string | 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The state of the instance.
* Possible values:
* ACTIVE
* CREATING
* DELETING
* UPGRADING
* REPAIRING
* STOPPED
* UPDATING
* SUSPENDED
*/
readonly state: pulumi.Output<string>;
/**
* The reason why the instance is in a certain state (e.g. SUSPENDED).
*/
readonly stateReason: pulumi.Output<string>;
/**
* Unique ID of the resource.
* This is unrelated to the access rules which allow specifying the root
* squash uid.
*/
readonly uid: pulumi.Output<string>;
/**
* Represents a scheduled maintenance event.
* Structure is documented below.
*/
readonly upcomingMaintenanceSchedules: pulumi.Output<outputs.lustre.InstanceUpcomingMaintenanceSchedule[]>;
/**
* Timestamp when the instance was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Instance 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: InstanceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Instance resources.
*/
export interface InstanceState {
/**
* IP-based access rules for the Managed Lustre instance. These options
* define the root user squash configuration.
* Structure is documented below.
*/
accessRulesOptions?: pulumi.Input<inputs.lustre.InstanceAccessRulesOptions | undefined>;
/**
* The storage capacity of the instance in gibibytes (GiB). Allowed values
* are from `9000` to `7632000`, depending on the `perUnitStorageThroughput`.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for specific minimums, maximums, and step sizes for each performance tier.
*/
capacityGib?: pulumi.Input<string | undefined>;
/**
* Timestamp when the instance 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 user-readable description of the instance.
*/
description?: pulumi.Input<string | undefined>;
/**
* Dynamic tier options for a Managed Lustre instance.
* Structure is documented below.
*/
dynamicTierOptions?: pulumi.Input<inputs.lustre.InstanceDynamicTierOptions | 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>;
/**
* The filesystem name for this instance. This name is used by client-side
* tools, including when mounting the instance. Must be eight characters or
* less and can only contain letters and numbers.
*/
filesystem?: pulumi.Input<string | undefined>;
/**
* Indicates whether you want to enable support for GKE clients. By default,
* GKE clients are not supported.
*/
gkeSupportEnabled?: pulumi.Input<boolean | undefined>;
/**
* The name of the Managed Lustre instance.
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
*/
instanceId?: pulumi.Input<string | undefined>;
/**
* The Cloud KMS key name to use for data encryption.
* If not set, the instance will use Google-managed encryption keys.
* If set, the instance will use customer-managed encryption keys.
* The key must be in the same region as the instance.
* The key format is:
* projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
*/
kmsKey?: pulumi.Input<string | 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>;
/**
* Defines a maintenance policy for a resource.
* Structure is documented below.
*/
maintenancePolicy?: pulumi.Input<inputs.lustre.InstanceMaintenancePolicy | undefined>;
/**
* Mount point of the instance in the format `IP_ADDRESS@tcp:/FILESYSTEM`.
*/
mountPoint?: pulumi.Input<string | undefined>;
/**
* Identifier. The name of the instance.
*/
name?: pulumi.Input<string | undefined>;
/**
* The full name of the VPC network to which the instance is connected.
* Must be in the format
* `projects/{project_id}/global/networks/{network_name}`.
*/
network?: pulumi.Input<string | undefined>;
/**
* The throughput of the instance in MBps per TiB. Valid values are 125, 250,
* 500, 1000.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for more information.
* If the instance is using the Dynamic tier, this field must not be set or
* must be set to zero.
*/
perUnitStorageThroughput?: pulumi.Input<string | undefined>;
/**
* The placement policy name for the instance in the format of
* projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
*/
placementPolicy?: 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>;
/**
* The state of the instance.
* Possible values:
* ACTIVE
* CREATING
* DELETING
* UPGRADING
* REPAIRING
* STOPPED
* UPDATING
* SUSPENDED
*/
state?: pulumi.Input<string | undefined>;
/**
* The reason why the instance is in a certain state (e.g. SUSPENDED).
*/
stateReason?: pulumi.Input<string | undefined>;
/**
* Unique ID of the resource.
* This is unrelated to the access rules which allow specifying the root
* squash uid.
*/
uid?: pulumi.Input<string | undefined>;
/**
* Represents a scheduled maintenance event.
* Structure is documented below.
*/
upcomingMaintenanceSchedules?: pulumi.Input<pulumi.Input<inputs.lustre.InstanceUpcomingMaintenanceSchedule>[] | undefined>;
/**
* Timestamp when the instance was last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Instance resource.
*/
export interface InstanceArgs {
/**
* IP-based access rules for the Managed Lustre instance. These options
* define the root user squash configuration.
* Structure is documented below.
*/
accessRulesOptions?: pulumi.Input<inputs.lustre.InstanceAccessRulesOptions | undefined>;
/**
* The storage capacity of the instance in gibibytes (GiB). Allowed values
* are from `9000` to `7632000`, depending on the `perUnitStorageThroughput`.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for specific minimums, maximums, and step sizes for each performance tier.
*/
capacityGib: pulumi.Input<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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A user-readable description of the instance.
*/
description?: pulumi.Input<string | undefined>;
/**
* Dynamic tier options for a Managed Lustre instance.
* Structure is documented below.
*/
dynamicTierOptions?: pulumi.Input<inputs.lustre.InstanceDynamicTierOptions | undefined>;
/**
* The filesystem name for this instance. This name is used by client-side
* tools, including when mounting the instance. Must be eight characters or
* less and can only contain letters and numbers.
*/
filesystem: pulumi.Input<string>;
/**
* Indicates whether you want to enable support for GKE clients. By default,
* GKE clients are not supported.
*/
gkeSupportEnabled?: pulumi.Input<boolean | undefined>;
/**
* The name of the Managed Lustre instance.
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
*/
instanceId: pulumi.Input<string>;
/**
* The Cloud KMS key name to use for data encryption.
* If not set, the instance will use Google-managed encryption keys.
* If set, the instance will use customer-managed encryption keys.
* The key must be in the same region as the instance.
* The key format is:
* projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
*/
kmsKey?: pulumi.Input<string | 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>;
/**
* Defines a maintenance policy for a resource.
* Structure is documented below.
*/
maintenancePolicy?: pulumi.Input<inputs.lustre.InstanceMaintenancePolicy | undefined>;
/**
* The full name of the VPC network to which the instance is connected.
* Must be in the format
* `projects/{project_id}/global/networks/{network_name}`.
*/
network: pulumi.Input<string>;
/**
* The throughput of the instance in MBps per TiB. Valid values are 125, 250,
* 500, 1000.
* See [Performance tiers and maximum storage
* capacities](https://cloud.google.com/managed-lustre/docs/create-instance#performance-tiers)
* for more information.
* If the instance is using the Dynamic tier, this field must not be set or
* must be set to zero.
*/
perUnitStorageThroughput?: pulumi.Input<string | undefined>;
/**
* The placement policy name for the instance in the format of
* projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
*/
placementPolicy?: 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>;
}
//# sourceMappingURL=instance.d.ts.map