getInstance function

Future<GetInstanceResult> getInstance(GetInstanceArgs args, { InvokeOptions? options, })

Get info about a Google Cloud Redis instance.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const myInstance = gcp.redis.getInstance({
    name: "my-redis-instance",
});
export const instanceMemorySizeGb = myInstance.then(myInstance => myInstance.memorySizeGb);
export const instanceConnectMode = myInstance.then(myInstance => myInstance.connectMode);
export const instanceAuthorizedNetwork = myInstance.then(myInstance => myInstance.authorizedNetwork);

import pulumi
import pulumi_gcp as gcp

my_instance = gcp.redis.get_instance(name="my-redis-instance")
pulumi.export("instanceMemorySizeGb", my_instance.memory_size_gb)
pulumi.export("instanceConnectMode", my_instance.connect_mode)
pulumi.export("instanceAuthorizedNetwork", my_instance.authorized_network)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var myInstance = Gcp.Redis.GetInstance.Invoke(new()
    {
        Name = "my-redis-instance",
    });

    return new Dictionary<string, object?>
    {
        ["instanceMemorySizeGb"] = myInstance.Apply(getInstanceResult => getInstanceResult.MemorySizeGb),
        ["instanceConnectMode"] = myInstance.Apply(getInstanceResult => getInstanceResult.ConnectMode),
        ["instanceAuthorizedNetwork"] = myInstance.Apply(getInstanceResult => getInstanceResult.AuthorizedNetwork),
    };
});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/redis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myInstance, err := redis.LookupInstance(ctx, &redis.LookupInstanceArgs{
			Name: "my-redis-instance",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("instanceMemorySizeGb", myInstance.MemorySizeGb)
		ctx.Export("instanceConnectMode", myInstance.ConnectMode)
		ctx.Export("instanceAuthorizedNetwork", myInstance.AuthorizedNetwork)
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_redis_getinstance" "myInstance" {
  name = "my-redis-instance"
}

output "instanceMemorySizeGb" {
  value = data.gcp_redis_getinstance.myInstance.memory_size_gb
}
output "instanceConnectMode" {
  value = data.gcp_redis_getinstance.myInstance.connect_mode
}
output "instanceAuthorizedNetwork" {
  value = data.gcp_redis_getinstance.myInstance.authorized_network
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.redis.RedisFunctions;
import com.pulumi.gcp.redis.inputs.GetInstanceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myInstance = RedisFunctions.getInstance(GetInstanceArgs.builder()
            .name("my-redis-instance")
            .build());

        ctx.export("instanceMemorySizeGb", myInstance.memorySizeGb());
        ctx.export("instanceConnectMode", myInstance.connectMode());
        ctx.export("instanceAuthorizedNetwork", myInstance.authorizedNetwork());
    }
}

variables:
  myInstance:
    fn::invoke:
      function: gcp:redis:getInstance
      arguments:
        name: my-redis-instance
outputs:
  instanceMemorySizeGb: ${myInstance.memorySizeGb}
  instanceConnectMode: ${myInstance.connectMode}
  instanceAuthorizedNetwork: ${myInstance.authorizedNetwork}

args Arguments passed to this invoke. Arguments for getInstance. options Invoke options controlling this call.

Implementation

Future<GetInstanceResult> getInstance(
  GetInstanceArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:redis/getInstance:getInstance',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetInstanceResult.fromMap(result);
}