Class CfnGlobalClusterProps

Properties for defining a CfnGlobalCluster.

Inheritance

object

CfnGlobalClusterProps

Implements

ICfnGlobalClusterProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnGlobalClusterProps : ICfnGlobalClusterProps

Syntax (vb)

Public Class CfnGlobalClusterProps Implements ICfnGlobalClusterProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnGlobalClusterProps = new CfnGlobalClusterProps {
                 DeletionProtection = false,
                 Engine = "engine",
                 EngineLifecycleSupport = "engineLifecycleSupport",
                 EngineVersion = "engineVersion",
                 GlobalClusterIdentifier = "globalClusterIdentifier",
                 SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
                 StorageEncrypted = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnGlobalClusterProps()

Properties for defining a CfnGlobalCluster.

Properties

DeletionProtection	Specifies whether to enable deletion protection for the new global database cluster.
Engine	The database engine to use for this global database cluster.
EngineLifecycleSupport	The life cycle type for this global database cluster.
EngineVersion	The engine version to use for this global database cluster.
GlobalClusterIdentifier	The cluster identifier for this global database cluster.
SourceDbClusterIdentifier	The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
StorageEncrypted	Specifies whether to enable storage encryption for the new global database cluster.
Tags	Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Constructors

CfnGlobalClusterProps()

Properties for defining a CfnGlobalCluster.

public CfnGlobalClusterProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var cfnGlobalClusterProps = new CfnGlobalClusterProps {
                 DeletionProtection = false,
                 Engine = "engine",
                 EngineLifecycleSupport = "engineLifecycleSupport",
                 EngineVersion = "engineVersion",
                 GlobalClusterIdentifier = "globalClusterIdentifier",
                 SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
                 StorageEncrypted = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DeletionProtection

Specifies whether to enable deletion protection for the new global database cluster.

public object? DeletionProtection { get; set; }

Property Value

object

Remarks

The global database can't be deleted when deletion protection is enabled.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-deletionprotection

Type union: either bool or IResolvable

Engine

The database engine to use for this global database cluster.

public string? Engine { get; set; }

Property Value

string

Remarks

Valid Values: aurora-mysql | aurora-postgresql

Constraints:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engine

EngineLifecycleSupport

The life cycle type for this global database cluster.

public string? EngineLifecycleSupport { get; set; }

Property Value

string

Remarks

By default, this value is set to <code>open-source-rds-extended-support</code> , which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to <code>open-source-rds-extended-support-disabled</code> . In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

This setting only applies to Aurora PostgreSQL-based global databases.

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide .

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-enginelifecyclesupport

EngineVersion

The engine version to use for this global database cluster.

public string? EngineVersion { get; set; }

Property Value

string

Remarks

Constraints:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engineversion

GlobalClusterIdentifier

The cluster identifier for this global database cluster.

public string? GlobalClusterIdentifier { get; set; }

Property Value

string

Remarks

This parameter is stored as a lowercase string.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-globalclusteridentifier

SourceDbClusterIdentifier

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

public object? SourceDbClusterIdentifier { get; set; }

Property Value

object

Remarks

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-sourcedbclusteridentifier

Type union: either string or IDBClusterRef

StorageEncrypted

Specifies whether to enable storage encryption for the new global database cluster.

public object? StorageEncrypted { get; set; }

Property Value

object

Remarks

Constraints:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-storageencrypted

Type union: either bool or IResolvable

Tags

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-tags

Implements

ICfnGlobalClusterProps