@pulumi/gcp/spanner/instanceConfig.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * A possible configuration for a Cloud Spanner instance. Configurations
 * define the geographic placement of nodes and their replication.
 *
 * To get more information about InstanceConfig, see:
 *
 * * [API documentation](https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instanceConfigs)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/spanner/)
 *
 * ## Example Usage
 *
 * ## Import
 *
 * InstanceConfig can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/instanceConfigs/{{name}}`
 *
 * * `{{project}}/{{name}}`
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, InstanceConfig can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:spanner/instanceConfig:InstanceConfig default projects/{{project}}/instanceConfigs/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:spanner/instanceConfig:InstanceConfig default {{project}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:spanner/instanceConfig:InstanceConfig default {{name}}
 * ```
 */
export declare class InstanceConfig extends pulumi.CustomResource {
    /**
     * Get an existing InstanceConfig 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?: InstanceConfigState, opts?: pulumi.CustomResourceOptions): InstanceConfig;
    /**
     * Returns true if the given object is an instance of InstanceConfig.  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 InstanceConfig;
    /**
     * Base configuration name, e.g. nam3, based on which this configuration is created.
     * Only set for user managed configurations.
     * baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
     */
    readonly baseConfig: pulumi.Output<string>;
    /**
     * Output only. Whether this instance config is a Google or User Managed Configuration.
     */
    readonly configType: pulumi.Output<string>;
    /**
     * The name of this instance configuration as it appears in UIs.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * 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;
    }>;
    /**
     * An object containing a list of "key": value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    /**
     * A unique identifier for the instance configuration. Values are of the
     * form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
     */
    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;
    }>;
    /**
     * The geographic placement of nodes in this instance configuration and their replication properties.
     * Structure is documented below.
     */
    readonly replicas: pulumi.Output<outputs.spanner.InstanceConfigReplica[]>;
    /**
     * Create a InstanceConfig 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: InstanceConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering InstanceConfig resources.
 */
export interface InstanceConfigState {
    /**
     * Base configuration name, e.g. nam3, based on which this configuration is created.
     * Only set for user managed configurations.
     * baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
     */
    baseConfig?: pulumi.Input<string>;
    /**
     * Output only. Whether this instance config is a Google or User Managed Configuration.
     */
    configType?: pulumi.Input<string>;
    /**
     * The name of this instance configuration as it appears in UIs.
     */
    displayName?: 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>;
    }>;
    /**
     * An object containing a list of "key": value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    }>;
    /**
     * A unique identifier for the instance configuration. Values are of the
     * form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
     */
    name?: 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>;
    }>;
    /**
     * The geographic placement of nodes in this instance configuration and their replication properties.
     * Structure is documented below.
     */
    replicas?: pulumi.Input<pulumi.Input<inputs.spanner.InstanceConfigReplica>[]>;
}
/**
 * The set of arguments for constructing a InstanceConfig resource.
 */
export interface InstanceConfigArgs {
    /**
     * Base configuration name, e.g. nam3, based on which this configuration is created.
     * Only set for user managed configurations.
     * baseConfig must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
     */
    baseConfig?: pulumi.Input<string>;
    /**
     * The name of this instance configuration as it appears in UIs.
     */
    displayName: pulumi.Input<string>;
    /**
     * An object containing a list of "key": value pairs.
     * Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
     *
     * **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>;
    }>;
    /**
     * A unique identifier for the instance configuration. Values are of the
     * form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
     */
    name?: 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 geographic placement of nodes in this instance configuration and their replication properties.
     * Structure is documented below.
     */
    replicas: pulumi.Input<pulumi.Input<inputs.spanner.InstanceConfigReplica>[]>;
}