Google Native

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

getInstance

Gets details of a single 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,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 location: 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:apigeeregistry/v1:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InstanceId string
Location string
Project string

InstanceId string
Location string
Project string

instanceId String
location String
project String

instanceId string
location string
project string

instance_id str
location str
project str

instanceId String
location String
project String

getInstance Result

The following output properties are available:

Config Pulumi.GoogleNative.ApigeeRegistry.V1.Outputs.ConfigResponse: Config of the Instance.
CreateTime string: Creation timestamp.
Name string: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
State string: The current state of the Instance.
StateMessage string: Extra information of Instance.State if the state is FAILED.
UpdateTime string: Last update timestamp.

Config ConfigResponse: Config of the Instance.
CreateTime string: Creation timestamp.
Name string: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
State string: The current state of the Instance.
StateMessage string: Extra information of Instance.State if the state is FAILED.
UpdateTime string: Last update timestamp.

config ConfigResponse: Config of the Instance.
createTime String: Creation timestamp.
name String: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
state String: The current state of the Instance.
stateMessage String: Extra information of Instance.State if the state is FAILED.
updateTime String: Last update timestamp.

config ConfigResponse: Config of the Instance.
createTime string: Creation timestamp.
name string: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
state string: The current state of the Instance.
stateMessage string: Extra information of Instance.State if the state is FAILED.
updateTime string: Last update timestamp.

config ConfigResponse: Config of the Instance.
create_time str: Creation timestamp.
name str: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
state str: The current state of the Instance.
state_message str: Extra information of Instance.State if the state is FAILED.
update_time str: Last update timestamp.

config Property Map: Config of the Instance.
createTime String: Creation timestamp.
name String: Format: projects/*/locations/*/instance. Currently only locations/global is supported.
state String: The current state of the Instance.
stateMessage String: Extra information of Instance.State if the state is FAILED.
updateTime String: Last update timestamp.

Supporting Types

ConfigResponse

CmekKeyName string: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
Location string: The GCP location where the Instance resides.

CmekKeyName string: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
Location string: The GCP location where the Instance resides.

cmekKeyName String: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
location String: The GCP location where the Instance resides.

cmekKeyName string: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
location string: The GCP location where the Instance resides.

cmek_key_name str: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
location str: The GCP location where the Instance resides.

cmekKeyName String: The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+), where the location must match InstanceConfig.location.
location String: The GCP location where the Instance resides.

Package Details

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