aws.rds.getGlobalCluster

AWS v7.10.0 published on Friday, Oct 24, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const example = aws.rds.getGlobalCluster({
    identifier: test.globalClusterIdentifier,
});

import pulumi
import pulumi_aws as aws

example = aws.rds.get_global_cluster(identifier=test["globalClusterIdentifier"])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.LookupGlobalCluster(ctx, &rds.LookupGlobalClusterArgs{
			Identifier: test.GlobalClusterIdentifier,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Rds.GetGlobalCluster.Invoke(new()
    {
        Identifier = test.GlobalClusterIdentifier,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetGlobalClusterArgs;
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 example = RdsFunctions.getGlobalCluster(GetGlobalClusterArgs.builder()
            .identifier(test.globalClusterIdentifier())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:rds:getGlobalCluster
      arguments:
        identifier: ${test.globalClusterIdentifier}

Using getGlobalCluster

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 getGlobalCluster(args: GetGlobalClusterArgs, opts?: InvokeOptions): Promise<GetGlobalClusterResult>
function getGlobalClusterOutput(args: GetGlobalClusterOutputArgs, opts?: InvokeOptions): Output<GetGlobalClusterResult>

def get_global_cluster(identifier: Optional[str] = None,
                       region: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGlobalClusterResult
def get_global_cluster_output(identifier: Optional[pulumi.Input[str]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGlobalClusterResult]

func LookupGlobalCluster(ctx *Context, args *LookupGlobalClusterArgs, opts ...InvokeOption) (*LookupGlobalClusterResult, error)
func LookupGlobalClusterOutput(ctx *Context, args *LookupGlobalClusterOutputArgs, opts ...InvokeOption) LookupGlobalClusterResultOutput

> Note: This function is named LookupGlobalCluster in the Go SDK.

public static class GetGlobalCluster 
{
    public static Task<GetGlobalClusterResult> InvokeAsync(GetGlobalClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalClusterResult> Invoke(GetGlobalClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)
public static Output<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)

fn::invoke:
  function: aws:rds/getGlobalCluster:getGlobalCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Identifier string

The global cluster identifier of the RDS global cluster.