Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. getGlobalCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getGlobalCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::RDS::GlobalCluster

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>
Copy
def get_global_cluster(global_cluster_identifier: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetGlobalClusterResult
def get_global_cluster_output(global_cluster_identifier: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetGlobalClusterResult]
Copy
func LookupGlobalCluster(ctx *Context, args *LookupGlobalClusterArgs, opts ...InvokeOption) (*LookupGlobalClusterResult, error)
func LookupGlobalClusterOutput(ctx *Context, args *LookupGlobalClusterOutputArgs, opts ...InvokeOption) LookupGlobalClusterResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)
public static Output<GetGlobalClusterResult> getGlobalCluster(GetGlobalClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:rds:getGlobalCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GlobalClusterIdentifier This property is required. string
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
GlobalClusterIdentifier This property is required. string
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
globalClusterIdentifier This property is required. String
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
globalClusterIdentifier This property is required. string
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
global_cluster_identifier This property is required. str
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.
globalClusterIdentifier This property is required. String
The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string.

getGlobalCluster Result

The following output properties are available:

DeletionProtection bool
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
EngineLifecycleSupport string
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
EngineVersion string
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
GlobalEndpoint Pulumi.AwsNative.Rds.Outputs.GlobalClusterGlobalEndpoint
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
DeletionProtection bool
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
EngineLifecycleSupport string
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
EngineVersion string
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
GlobalEndpoint GlobalClusterGlobalEndpoint
Tags Tag
An array of key-value pairs to apply to this resource.
deletionProtection Boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
engineLifecycleSupport String
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
engineVersion String
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
globalEndpoint GlobalClusterGlobalEndpoint
tags List<Tag>
An array of key-value pairs to apply to this resource.
deletionProtection boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
engineLifecycleSupport string
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
engineVersion string
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
globalEndpoint GlobalClusterGlobalEndpoint
tags Tag[]
An array of key-value pairs to apply to this resource.
deletion_protection bool
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
engine_lifecycle_support str
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
engine_version str
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
global_endpoint GlobalClusterGlobalEndpoint
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
deletionProtection Boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
engineLifecycleSupport String
The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.
engineVersion String
The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.
globalEndpoint Property Map
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

GlobalClusterGlobalEndpoint

Address string
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
Address string
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
address String
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
address string
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
address str
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
address String
The writer endpoint for the global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native