Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getInstance

Gets information about an 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(instance_id: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(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:bigtableadmin/v2:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InstanceId string
Project string
InstanceId string
Project string
instanceId String
project String
instanceId string
project string
instanceId String
project String

getInstance Result

The following output properties are available:

CreateTime string

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

DisplayName string

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

Labels Dictionary<string, string>

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

Name string

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

SatisfiesPzs bool

Reserved for future use.

State string

The current state of the instance.

Type string

The type of the instance. Defaults to PRODUCTION.

CreateTime string

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

DisplayName string

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

Labels map[string]string

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

Name string

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

SatisfiesPzs bool

Reserved for future use.

State string

The current state of the instance.

Type string

The type of the instance. Defaults to PRODUCTION.

createTime String

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

displayName String

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

labels Map<String,String>

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

name String

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

satisfiesPzs Boolean

Reserved for future use.

state String

The current state of the instance.

type String

The type of the instance. Defaults to PRODUCTION.

createTime string

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

displayName string

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

labels {[key: string]: string}

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

name string

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

satisfiesPzs boolean

Reserved for future use.

state string

The current state of the instance.

type string

The type of the instance. Defaults to PRODUCTION.

create_time str

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

display_name str

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

labels Mapping[str, str]

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

name str

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

satisfies_pzs bool

Reserved for future use.

state str

The current state of the instance.

type str

The type of the instance. Defaults to PRODUCTION.

createTime String

A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1.

displayName String

The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

labels Map<String>

Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \p{Ll}\p{Lo}{0,62}. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.

name String

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

satisfiesPzs Boolean

Reserved for future use.

state String

The current state of the instance.

type String

The type of the instance. Defaults to PRODUCTION.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0