com.pulumi.gcp.redis.kotlin.RedisFunctions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.20.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.redis.kotlin

import com.pulumi.gcp.redis.RedisFunctions.getInstancePlain
import com.pulumi.gcp.redis.kotlin.inputs.GetInstancePlainArgs
import com.pulumi.gcp.redis.kotlin.inputs.GetInstancePlainArgsBuilder
import com.pulumi.gcp.redis.kotlin.outputs.GetInstanceResult
import com.pulumi.gcp.redis.kotlin.outputs.GetInstanceResult.Companion.toKotlin
import kotlinx.coroutines.future.await
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

public object RedisFunctions {
    /**
     * Get info about a Google Cloud Redis instance.
     * ## Example Usage
     * 
     * ```typescript
     * 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);
     * ```
     * ```python
     * 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)
     * ```
     * ```csharp
     * 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
     *     {
     *         ["instanceMemorySizeGb"] = myInstance.Apply(getInstanceResult => getInstanceResult.MemorySizeGb),
     *         ["instanceConnectMode"] = myInstance.Apply(getInstanceResult => getInstanceResult.ConnectMode),
     *         ["instanceAuthorizedNetwork"] = myInstance.Apply(getInstanceResult => getInstanceResult.AuthorizedNetwork),
     *     };
     * });
     * ```
     * ```go
     * package main
     * import (
     * 	"github.com/pulumi/pulumi-gcp/sdk/v8/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
     * 	})
     * }
     * ```
     * ```java
     * 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.List;
     * import java.util.ArrayList;
     * 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.applyValue(getInstanceResult -> getInstanceResult.memorySizeGb()));
     *         ctx.export("instanceConnectMode", myInstance.applyValue(getInstanceResult -> getInstanceResult.connectMode()));
     *         ctx.export("instanceAuthorizedNetwork", myInstance.applyValue(getInstanceResult -> getInstanceResult.authorizedNetwork()));
     *     }
     * }
     * ```
     * ```yaml
     * variables:
     *   myInstance:
     *     fn::invoke:
     *       function: gcp:redis:getInstance
     *       arguments:
     *         name: my-redis-instance
     * outputs:
     *   instanceMemorySizeGb: ${myInstance.memorySizeGb}
     *   instanceConnectMode: ${myInstance.connectMode}
     *   instanceAuthorizedNetwork: ${myInstance.authorizedNetwork}
     * ```
     * 
     * @param argument A collection of arguments for invoking getInstance.
     * @return A collection of values returned by getInstance.
     */
    public suspend fun getInstance(argument: GetInstancePlainArgs): GetInstanceResult =
        toKotlin(getInstancePlain(argument.toJava()).await())

    /**
     * @see [getInstance].
     * @param name The name of a Redis instance.
     * - - -
     * @param project The project in which the resource belongs. If it
     * is not provided, the provider project is used.
     * @param region The region in which the resource belongs. If it
     * is not provided, the provider region is used.
     * @return A collection of values returned by getInstance.
     */
    public suspend fun getInstance(
        name: String,
        project: String? = null,
        region: String? = null,
    ): GetInstanceResult {
        val argument = GetInstancePlainArgs(
            name = name,
            project = project,
            region = region,
        )
        return toKotlin(getInstancePlain(argument.toJava()).await())
    }

    /**
     * @see [getInstance].
     * @param argument Builder for [com.pulumi.gcp.redis.kotlin.inputs.GetInstancePlainArgs].
     * @return A collection of values returned by getInstance.
     */
    public suspend fun getInstance(argument: suspend GetInstancePlainArgsBuilder.() -> Unit): GetInstanceResult {
        val builder = GetInstancePlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return toKotlin(getInstancePlain(builtArgument.toJava()).await())
    }
}