Class GlobalCluster

Manages an RDS Global Cluster, which is an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

More information about Aurora global databases can be found in the Aurora User Guide.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var primary = new Aws.Provider("primary", new Aws.ProviderArgs
    {
        Region = "us-east-2",
    });
    var secondary = new Aws.Provider("secondary", new Aws.ProviderArgs
    {
        Region = "us-west-2",
    });
    var example = new Aws.Rds.GlobalCluster("example", new Aws.Rds.GlobalClusterArgs
    {
        GlobalClusterIdentifier = "example",
    });
    var primaryCluster = new Aws.Rds.Cluster("primaryCluster", new Aws.Rds.ClusterArgs
    {
        EngineMode = "global",
        GlobalClusterIdentifier = example.Id,
    });
    var primaryClusterInstance = new Aws.Rds.ClusterInstance("primaryClusterInstance", new Aws.Rds.ClusterInstanceArgs
    {
        ClusterIdentifier = primaryCluster.Id,
    });
    var secondaryCluster = new Aws.Rds.Cluster("secondaryCluster", new Aws.Rds.ClusterArgs
    {
        EngineMode = "global",
        GlobalClusterIdentifier = example.Id,
    });
    var secondaryClusterInstance = new Aws.Rds.ClusterInstance("secondaryClusterInstance", new Aws.Rds.ClusterInstanceArgs
    {
        ClusterIdentifier = secondaryCluster.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

GlobalCluster

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Rds

Assembly: Pulumi.Aws.dll

Syntax

public class GlobalCluster : CustomResource

Constructors

GlobalCluster(String, GlobalClusterArgs, CustomResourceOptions)

Create a GlobalCluster resource with the given unique name, arguments, and options.

Declaration

public GlobalCluster(string name, GlobalClusterArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GlobalClusterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

RDS Global Cluster Amazon Resource Name (ARN)

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

DatabaseName

Name for an automatically created database on cluster creation.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

DeletionProtection

If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

Declaration

public Output<bool?> DeletionProtection { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Engine

Name of the database engine to be used for this DB cluster. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora.

Declaration

public Output<string> Engine { get; }

Property Value

Type	Description
Output<System.String>

EngineVersion

Engine version of the Aurora global database.

• NOTE: When the engine is set to aurora-mysql, an engine version compatible with global database is required. The earliest available version is 5.7.mysql_aurora.2.06.0.

Declaration

public Output<string> EngineVersion { get; }

Property Value

Type	Description
Output<System.String>

GlobalClusterIdentifier

The global cluster identifier.

Declaration

public Output<string> GlobalClusterIdentifier { get; }

Property Value

Type	Description
Output<System.String>

GlobalClusterResourceId

AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed

Declaration

public Output<string> GlobalClusterResourceId { get; }

Property Value

Type	Description
Output<System.String>

StorageEncrypted

Specifies whether the DB cluster is encrypted. The default is false.

Declaration

public Output<bool?> StorageEncrypted { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, GlobalClusterState, CustomResourceOptions)

Get an existing GlobalCluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static GlobalCluster Get(string name, Input<string> id, GlobalClusterState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GlobalClusterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
GlobalCluster