Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. spanner
  5. spanner/v1
  6. getInstanceConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.spanner/v1.getInstanceConfig

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets information about a particular instance configuration.

    Using getInstanceConfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstanceConfig(args: GetInstanceConfigArgs, opts?: InvokeOptions): Promise<GetInstanceConfigResult>
function getInstanceConfigOutput(args: GetInstanceConfigOutputArgs, opts?: InvokeOptions): Output<GetInstanceConfigResult>
    def get_instance_config(instance_config_id: Optional[str] = None,
                        project: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetInstanceConfigResult
def get_instance_config_output(instance_config_id: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetInstanceConfigResult]
    func LookupInstanceConfig(ctx *Context, args *LookupInstanceConfigArgs, opts ...InvokeOption) (*LookupInstanceConfigResult, error)
func LookupInstanceConfigOutput(ctx *Context, args *LookupInstanceConfigOutputArgs, opts ...InvokeOption) LookupInstanceConfigResultOutput

    > Note: This function is named LookupInstanceConfig in the Go SDK.

    public static class GetInstanceConfig 
{
    public static Task<GetInstanceConfigResult> InvokeAsync(GetInstanceConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceConfigResult> Invoke(GetInstanceConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceConfigResult> getInstanceConfig(GetInstanceConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:spanner/v1:getInstanceConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getInstanceConfig Result

    The following output properties are available:

    BaseConfig string
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    ConfigType string
    Whether this instance config is a Google or User Managed Configuration.
    DisplayName string
    The name of this instance configuration as it appears in UIs.
    Etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    FreeInstanceAvailability string
    Describes whether free instances are available to be created in this instance config.
    Labels Dictionary<string, 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.
    LeaderOptions List<string>
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    Name string
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    OptionalReplicas List<Pulumi.GoogleNative.Spanner.V1.Outputs.ReplicaInfoResponse>
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    Reconciling bool
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    Replicas List<Pulumi.GoogleNative.Spanner.V1.Outputs.ReplicaInfoResponse>
    The geographic placement of nodes in this instance configuration and their replication properties.
    State string
    The current instance config state. Applicable only for USER_MANAGED configs.
    BaseConfig string
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    ConfigType string
    Whether this instance config is a Google or User Managed Configuration.
    DisplayName string
    The name of this instance configuration as it appears in UIs.
    Etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    FreeInstanceAvailability string
    Describes whether free instances are available to be created in this instance config.
    Labels map[string]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.
    LeaderOptions []string
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    Name string
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    OptionalReplicas []ReplicaInfoResponse
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    Reconciling bool
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    Replicas []ReplicaInfoResponse
    The geographic placement of nodes in this instance configuration and their replication properties.
    State string
    The current instance config state. Applicable only for USER_MANAGED configs.
    baseConfig String
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    configType String
    Whether this instance config is a Google or User Managed Configuration.
    displayName String
    The name of this instance configuration as it appears in UIs.
    etag String
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    freeInstanceAvailability String
    Describes whether free instances are available to be created in this instance config.
    labels Map<String,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.
    leaderOptions List<String>
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    name String
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    optionalReplicas List<ReplicaInfoResponse>
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    reconciling Boolean
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    replicas List<ReplicaInfoResponse>
    The geographic placement of nodes in this instance configuration and their replication properties.
    state String
    The current instance config state. Applicable only for USER_MANAGED configs.
    baseConfig string
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    configType string
    Whether this instance config is a Google or User Managed Configuration.
    displayName string
    The name of this instance configuration as it appears in UIs.
    etag string
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    freeInstanceAvailability string
    Describes whether free instances are available to be created in this instance config.
    labels {[key: string]: 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.
    leaderOptions string[]
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    name string
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    optionalReplicas ReplicaInfoResponse[]
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    reconciling boolean
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    replicas ReplicaInfoResponse[]
    The geographic placement of nodes in this instance configuration and their replication properties.
    state string
    The current instance config state. Applicable only for USER_MANAGED configs.
    base_config str
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    config_type str
    Whether this instance config is a Google or User Managed Configuration.
    display_name str
    The name of this instance configuration as it appears in UIs.
    etag str
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    free_instance_availability str
    Describes whether free instances are available to be created in this instance config.
    labels Mapping[str, str]
    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.
    leader_options Sequence[str]
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    name str
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    optional_replicas Sequence[ReplicaInfoResponse]
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    reconciling bool
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    replicas Sequence[ReplicaInfoResponse]
    The geographic placement of nodes in this instance configuration and their replication properties.
    state str
    The current instance config state. Applicable only for USER_MANAGED configs.
    baseConfig String
    Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
    configType String
    Whether this instance config is a Google or User Managed Configuration.
    displayName String
    The name of this instance configuration as it appears in UIs.
    etag String
    etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
    freeInstanceAvailability String
    Describes whether free instances are available to be created in this instance config.
    labels Map<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.
    leaderOptions List<String>
    Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
    name String
    A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
    optionalReplicas List<Property Map>
    The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
    reconciling Boolean
    If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
    replicas List<Property Map>
    The geographic placement of nodes in this instance configuration and their replication properties.
    state String
    The current instance config state. Applicable only for USER_MANAGED configs.

    Supporting Types

    ReplicaInfoResponse

    DefaultLeaderLocation bool
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    Location string
    The location of the serving resources, e.g. "us-central1".
    Type string
    The type of replica.
    DefaultLeaderLocation bool
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    Location string
    The location of the serving resources, e.g. "us-central1".
    Type string
    The type of replica.
    defaultLeaderLocation Boolean
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    location String
    The location of the serving resources, e.g. "us-central1".
    type String
    The type of replica.
    defaultLeaderLocation boolean
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    location string
    The location of the serving resources, e.g. "us-central1".
    type string
    The type of replica.
    default_leader_location bool
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    location str
    The location of the serving resources, e.g. "us-central1".
    type str
    The type of replica.
    defaultLeaderLocation Boolean
    If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.
    location String
    The location of the serving resources, e.g. "us-central1".
    type String
    The type of replica.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native