UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

537 lines (536 loc) • 20.8 kB
import * as pulumi from "@pulumi/pulumi"; /** * A Parallelstore Instance. * * ## Example Usage * * ### Parallelstore Instance Basic Beta * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const network = new gcp.compute.Network("network", { * name: "network", * autoCreateSubnetworks: true, * mtu: 8896, * }); * // Create an IP address * const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", { * name: "address", * purpose: "VPC_PEERING", * addressType: "INTERNAL", * prefixLength: 24, * network: network.id, * }); * // Create a private connection * const _default = new gcp.servicenetworking.Connection("default", { * network: network.id, * service: "servicenetworking.googleapis.com", * reservedPeeringRanges: [privateIpAlloc.name], * }); * const instance = new gcp.parallelstore.Instance("instance", { * instanceId: "instance", * location: "us-central1-a", * description: "test instance", * capacityGib: "12000", * network: network.name, * fileStripeLevel: "FILE_STRIPE_LEVEL_MIN", * directoryStripeLevel: "DIRECTORY_STRIPE_LEVEL_MIN", * deploymentType: "SCRATCH", * labels: { * test: "value", * }, * }, { * dependsOn: [_default], * }); * ``` * ### Parallelstore Instance Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const network = new gcp.compute.Network("network", { * name: "network", * autoCreateSubnetworks: true, * mtu: 8896, * }); * // Create an IP address * const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", { * name: "address", * purpose: "VPC_PEERING", * addressType: "INTERNAL", * prefixLength: 24, * network: network.id, * }); * // Create a private connection * const _default = new gcp.servicenetworking.Connection("default", { * network: network.id, * service: "servicenetworking.googleapis.com", * reservedPeeringRanges: [privateIpAlloc.name], * }); * const instance = new gcp.parallelstore.Instance("instance", { * instanceId: "instance", * location: "us-central1-a", * description: "test instance", * capacityGib: "12000", * network: network.name, * fileStripeLevel: "FILE_STRIPE_LEVEL_MIN", * directoryStripeLevel: "DIRECTORY_STRIPE_LEVEL_MIN", * deploymentType: "SCRATCH", * labels: { * test: "value", * }, * }, { * dependsOn: [_default], * }); * ``` * * ## 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:parallelstore/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{instance_id}} * ``` * * ```sh * $ pulumi import gcp:parallelstore/instance:Instance default {{project}}/{{location}}/{{instance_id}} * ``` * * ```sh * $ pulumi import gcp:parallelstore/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; /** * Output only. List of access_points. * Contains a list of IPv4 addresses used for client side configuration. */ readonly accessPoints: pulumi.Output<string[]>; /** * Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB). */ readonly capacityGib: pulumi.Output<string>; /** * The time when the instance was created. */ readonly createTime: pulumi.Output<string>; /** * The version of DAOS software running in the instance. */ readonly daosVersion: pulumi.Output<string>; /** * Parallelstore Instance deployment type. * Possible values: * DEPLOYMENT_TYPE_UNSPECIFIED * SCRATCH * PERSISTENT */ readonly deploymentType: pulumi.Output<string | undefined>; /** * The description of the instance. 2048 characters or less. */ readonly description: pulumi.Output<string | undefined>; /** * Stripe level for directories. * MIN when directory has a small number of files. * MAX when directory has a large number of files. * Possible values: * DIRECTORY_STRIPE_LEVEL_UNSPECIFIED * DIRECTORY_STRIPE_LEVEL_MIN * DIRECTORY_STRIPE_LEVEL_BALANCED * DIRECTORY_STRIPE_LEVEL_MAX */ readonly directoryStripeLevel: 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; }>; /** * Immutable. Contains the id of the allocated IP address * range associated with the private service access connection for example, \"test-default\" * associated with IP range 10.0.0.0/29. This field is populated by the service * and contains the value currently used by the service. */ readonly effectiveReservedIpRange: pulumi.Output<string>; /** * Stripe level for files. * MIN better suited for small size files. * MAX higher throughput performance for larger files. * Possible values: * FILE_STRIPE_LEVEL_UNSPECIFIED * FILE_STRIPE_LEVEL_MIN * FILE_STRIPE_LEVEL_BALANCED * FILE_STRIPE_LEVEL_MAX */ readonly fileStripeLevel: pulumi.Output<string | undefined>; /** * The logical name of the Parallelstore instance in the user project with the following restrictions: * * 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. * * Must be unique within the customer project/ location */ readonly instanceId: pulumi.Output<string>; /** * Cloud Labels are a flexible and lightweight mechanism for * organizing cloud resources into groups that reflect a customer's organizational * needs and deployment strategies. Cloud Labels can be used to filter collections * of resources. They can be used to control how resource metrics are aggregated. * And they can be used as arguments to policy management rules (e.g. route, firewall, * load balancing, etc.). * * Label keys must be between 1 and 63 characters long and must conform to * the following regular expression: `a-z{0,62}`. * * Label values must be between 0 and 63 characters long and must conform * to the regular expression `[a-z0-9_-]{0,63}`. * * No more than 64 labels can be associated with a given resource. * See https://goo.gl/xmQnxf for more information on and examples of labels. * If you plan to use labels in your own code, please note that additional * characters may be allowed in the future. Therefore, you are advised to use * an internal label representation, such as JSON, which doesn't rely upon * specific characters being disallowed. For example, representing labels * as the string: `name + "_" + value` would prove problematic if we were to * allow `"_"` in a future release. " * * **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>; /** * Part of `parent`. See documentation of `projectsId`. */ readonly location: pulumi.Output<string>; /** * Identifier. The resource name of the instance, in the format * `projects/{project}/locations/{location}/instances/{instance_id}` */ readonly name: pulumi.Output<string>; /** * Immutable. The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) * to which the instance is connected. */ readonly network: 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; }>; /** * Immutable. Contains the id of the allocated IP address range * associated with the private service access connection for example, \"test-default\" * associated with IP range 10.0.0.0/29. If no range id is provided all ranges will * be considered. */ readonly reservedIpRange: pulumi.Output<string | undefined>; /** * The instance state. * Possible values: * STATE_UNSPECIFIED * CREATING * ACTIVE * DELETING * FAILED * UPGRADING */ readonly state: pulumi.Output<string>; /** * The time when the instance was 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 { /** * Output only. List of access_points. * Contains a list of IPv4 addresses used for client side configuration. */ accessPoints?: pulumi.Input<pulumi.Input<string>[]>; /** * Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB). */ capacityGib?: pulumi.Input<string>; /** * The time when the instance was created. */ createTime?: pulumi.Input<string>; /** * The version of DAOS software running in the instance. */ daosVersion?: pulumi.Input<string>; /** * Parallelstore Instance deployment type. * Possible values: * DEPLOYMENT_TYPE_UNSPECIFIED * SCRATCH * PERSISTENT */ deploymentType?: pulumi.Input<string>; /** * The description of the instance. 2048 characters or less. */ description?: pulumi.Input<string>; /** * Stripe level for directories. * MIN when directory has a small number of files. * MAX when directory has a large number of files. * Possible values: * DIRECTORY_STRIPE_LEVEL_UNSPECIFIED * DIRECTORY_STRIPE_LEVEL_MIN * DIRECTORY_STRIPE_LEVEL_BALANCED * DIRECTORY_STRIPE_LEVEL_MAX */ directoryStripeLevel?: pulumi.Input<string>; /** * 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>; }>; /** * Immutable. Contains the id of the allocated IP address * range associated with the private service access connection for example, \"test-default\" * associated with IP range 10.0.0.0/29. This field is populated by the service * and contains the value currently used by the service. */ effectiveReservedIpRange?: pulumi.Input<string>; /** * Stripe level for files. * MIN better suited for small size files. * MAX higher throughput performance for larger files. * Possible values: * FILE_STRIPE_LEVEL_UNSPECIFIED * FILE_STRIPE_LEVEL_MIN * FILE_STRIPE_LEVEL_BALANCED * FILE_STRIPE_LEVEL_MAX */ fileStripeLevel?: pulumi.Input<string>; /** * The logical name of the Parallelstore instance in the user project with the following restrictions: * * 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. * * Must be unique within the customer project/ location */ instanceId?: pulumi.Input<string>; /** * Cloud Labels are a flexible and lightweight mechanism for * organizing cloud resources into groups that reflect a customer's organizational * needs and deployment strategies. Cloud Labels can be used to filter collections * of resources. They can be used to control how resource metrics are aggregated. * And they can be used as arguments to policy management rules (e.g. route, firewall, * load balancing, etc.). * * Label keys must be between 1 and 63 characters long and must conform to * the following regular expression: `a-z{0,62}`. * * Label values must be between 0 and 63 characters long and must conform * to the regular expression `[a-z0-9_-]{0,63}`. * * No more than 64 labels can be associated with a given resource. * See https://goo.gl/xmQnxf for more information on and examples of labels. * If you plan to use labels in your own code, please note that additional * characters may be allowed in the future. Therefore, you are advised to use * an internal label representation, such as JSON, which doesn't rely upon * specific characters being disallowed. For example, representing labels * as the string: `name + "_" + value` would prove problematic if we were to * allow `"_"` in a future release. " * * **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>; }>; /** * Part of `parent`. See documentation of `projectsId`. */ location?: pulumi.Input<string>; /** * Identifier. The resource name of the instance, in the format * `projects/{project}/locations/{location}/instances/{instance_id}` */ name?: pulumi.Input<string>; /** * Immutable. The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) * to which the instance is connected. */ network?: 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>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Immutable. Contains the id of the allocated IP address range * associated with the private service access connection for example, \"test-default\" * associated with IP range 10.0.0.0/29. If no range id is provided all ranges will * be considered. */ reservedIpRange?: pulumi.Input<string>; /** * The instance state. * Possible values: * STATE_UNSPECIFIED * CREATING * ACTIVE * DELETING * FAILED * UPGRADING */ state?: pulumi.Input<string>; /** * The time when the instance was updated. */ updateTime?: pulumi.Input<string>; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * Required. Immutable. Storage capacity of Parallelstore instance in Gibibytes (GiB). */ capacityGib: pulumi.Input<string>; /** * Parallelstore Instance deployment type. * Possible values: * DEPLOYMENT_TYPE_UNSPECIFIED * SCRATCH * PERSISTENT */ deploymentType?: pulumi.Input<string>; /** * The description of the instance. 2048 characters or less. */ description?: pulumi.Input<string>; /** * Stripe level for directories. * MIN when directory has a small number of files. * MAX when directory has a large number of files. * Possible values: * DIRECTORY_STRIPE_LEVEL_UNSPECIFIED * DIRECTORY_STRIPE_LEVEL_MIN * DIRECTORY_STRIPE_LEVEL_BALANCED * DIRECTORY_STRIPE_LEVEL_MAX */ directoryStripeLevel?: pulumi.Input<string>; /** * Stripe level for files. * MIN better suited for small size files. * MAX higher throughput performance for larger files. * Possible values: * FILE_STRIPE_LEVEL_UNSPECIFIED * FILE_STRIPE_LEVEL_MIN * FILE_STRIPE_LEVEL_BALANCED * FILE_STRIPE_LEVEL_MAX */ fileStripeLevel?: pulumi.Input<string>; /** * The logical name of the Parallelstore instance in the user project with the following restrictions: * * 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. * * Must be unique within the customer project/ location */ instanceId: pulumi.Input<string>; /** * Cloud Labels are a flexible and lightweight mechanism for * organizing cloud resources into groups that reflect a customer's organizational * needs and deployment strategies. Cloud Labels can be used to filter collections * of resources. They can be used to control how resource metrics are aggregated. * And they can be used as arguments to policy management rules (e.g. route, firewall, * load balancing, etc.). * * Label keys must be between 1 and 63 characters long and must conform to * the following regular expression: `a-z{0,62}`. * * Label values must be between 0 and 63 characters long and must conform * to the regular expression `[a-z0-9_-]{0,63}`. * * No more than 64 labels can be associated with a given resource. * See https://goo.gl/xmQnxf for more information on and examples of labels. * If you plan to use labels in your own code, please note that additional * characters may be allowed in the future. Therefore, you are advised to use * an internal label representation, such as JSON, which doesn't rely upon * specific characters being disallowed. For example, representing labels * as the string: `name + "_" + value` would prove problematic if we were to * allow `"_"` in a future release. " * * **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>; }>; /** * Part of `parent`. See documentation of `projectsId`. */ location: pulumi.Input<string>; /** * Immutable. The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) * to which the instance is connected. */ network?: 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>; /** * Immutable. Contains the id of the allocated IP address range * associated with the private service access connection for example, \"test-default\" * associated with IP range 10.0.0.0/29. If no range id is provided all ranges will * be considered. */ reservedIpRange?: pulumi.Input<string>; }