Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.spanner/v1.getInstance
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets information about a particular instance.
Using getInstance
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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(field_mask: Optional[str] = None,
instance_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(field_mask: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput
> Note: This function is named LookupInstance
in the Go SDK.
public static class GetInstance
{
public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:spanner/v1:getInstance
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - Field
Mask string - Project string
- Instance
Id string - Field
Mask string - Project string
- instance
Id String - field
Mask String - project String
- instance
Id string - field
Mask string - project string
- instance_
id str - field_
mask str - project str
- instance
Id String - field
Mask String - project String
getInstance Result
The following output properties are available:
- Config string
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- Create
Time string The time at which the instance was created.
- Display
Name string The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- Endpoint
Uris List<string> Deprecated. This field is not populated.
Deprecated. This field is not populated.
- Free
Instance Pulumi.Metadata Google Native. Spanner. V1. Outputs. Free Instance Metadata Response Free instance metadata. Only populated for free instances.
- Instance
Type string The
InstanceType
of the current instance.- 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. And so 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.- Name string
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- Node
Count int The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- Processing
Units int The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- State string
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- Update
Time string The time at which the instance was most recently updated.
- Config string
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- Create
Time string The time at which the instance was created.
- Display
Name string The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- Endpoint
Uris []string Deprecated. This field is not populated.
Deprecated. This field is not populated.
- Free
Instance FreeMetadata Instance Metadata Response Free instance metadata. Only populated for free instances.
- Instance
Type string The
InstanceType
of the current instance.- 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. And so 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.- Name string
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- Node
Count int The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- Processing
Units int The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- State string
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- Update
Time string The time at which the instance was most recently updated.
- config String
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- create
Time String The time at which the instance was created.
- display
Name String The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- endpoint
Uris List<String> Deprecated. This field is not populated.
Deprecated. This field is not populated.
- free
Instance FreeMetadata Instance Metadata Response Free instance metadata. Only populated for free instances.
- instance
Type String The
InstanceType
of the current instance.- 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. And so 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.- name String
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- node
Count Integer The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- processing
Units Integer The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- state String
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- update
Time String The time at which the instance was most recently updated.
- config string
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- create
Time string The time at which the instance was created.
- display
Name string The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- endpoint
Uris string[] Deprecated. This field is not populated.
Deprecated. This field is not populated.
- free
Instance FreeMetadata Instance Metadata Response Free instance metadata. Only populated for free instances.
- instance
Type string The
InstanceType
of the current instance.- 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. And so 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.- name string
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- node
Count number The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- processing
Units number The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- state string
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- update
Time string The time at which the instance was most recently updated.
- config str
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- create_
time str The time at which the instance was created.
- display_
name str The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- endpoint_
uris Sequence[str] Deprecated. This field is not populated.
Deprecated. This field is not populated.
- free_
instance_ Freemetadata Instance Metadata Response Free instance metadata. Only populated for free instances.
- instance_
type str The
InstanceType
of the current instance.- 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. And so 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.- name str
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- node_
count int The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- processing_
units int The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- state str
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- update_
time str The time at which the instance was most recently updated.
- config String
The name of the instance's configuration. Values are of the form
projects//instanceConfigs/
. See also InstanceConfig and ListInstanceConfigs.- create
Time String The time at which the instance was created.
- display
Name String The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
- endpoint
Uris List<String> Deprecated. This field is not populated.
Deprecated. This field is not populated.
- free
Instance Property MapMetadata Free instance metadata. Only populated for free instances.
- instance
Type String The
InstanceType
of the current instance.- 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. And so 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.- name String
A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be between 2 and 64 characters in length.- node
Count Number The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- processing
Units Number The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state
READY
. See the documentation for more information about nodes and processing units.- state String
The current instance state. For CreateInstance, the state must be either omitted or set to
CREATING
. For UpdateInstance, the state must be either omitted or set toREADY
.- update
Time String The time at which the instance was most recently updated.
Supporting Types
FreeInstanceMetadataResponse
- Expire
Behavior string Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- Expire
Time string Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- Upgrade
Time string If present, the timestamp at which the free instance was upgraded to a provisioned instance.
- Expire
Behavior string Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- Expire
Time string Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- Upgrade
Time string If present, the timestamp at which the free instance was upgraded to a provisioned instance.
- expire
Behavior String Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- expire
Time String Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- upgrade
Time String If present, the timestamp at which the free instance was upgraded to a provisioned instance.
- expire
Behavior string Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- expire
Time string Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- upgrade
Time string If present, the timestamp at which the free instance was upgraded to a provisioned instance.
- expire_
behavior str Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- expire_
time str Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- upgrade_
time str If present, the timestamp at which the free instance was upgraded to a provisioned instance.
- expire
Behavior String Specifies the expiration behavior of a free instance. The default of ExpireBehavior is
REMOVE_AFTER_GRACE_PERIOD
. This can be modified during or after creation, and before expiration.- expire
Time String Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
- upgrade
Time String If present, the timestamp at which the free instance was upgraded to a provisioned instance.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.