Class CfnGlobalCluster
A CloudFormation AWS::RDS::GlobalCluster
.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnGlobalCluster : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnGlobalCluster
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::RDS::GlobalCluster
resource creates or updates an Amazon Aurora global database spread across multiple AWS 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.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it.
For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
CloudformationResource: AWS::RDS::GlobalCluster
Link: 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 cfnGlobalCluster = new CfnGlobalCluster(this, "MyCfnGlobalCluster", new CfnGlobalClusterProps {
DeletionProtection = false,
Engine = "engine",
EngineVersion = "engineVersion",
GlobalClusterIdentifier = "globalClusterIdentifier",
SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
StorageEncrypted = false
});
Synopsis
Constructors
CfnGlobalCluster(Construct, String, ICfnGlobalClusterProps) | Create a new |
CfnGlobalCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGlobalCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeletionProtection | The deletion protection setting for the new global database. |
Engine | The name of the database engine to be used for this DB cluster. |
EngineVersion | The engine version of the Aurora global database. |
GlobalClusterIdentifier | The cluster identifier of the global database cluster. |
SourceDbClusterIdentifier | The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database. |
StorageEncrypted | The storage encryption setting for the global database cluster. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGlobalCluster(Construct, String, ICfnGlobalClusterProps)
Create a new AWS::RDS::GlobalCluster
.
public CfnGlobalCluster(Construct scope, string id, ICfnGlobalClusterProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnGlobalClusterProps
- resource properties.
CfnGlobalCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGlobalCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGlobalCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGlobalCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeletionProtection
The deletion protection setting for the new global database.
public virtual object DeletionProtection { get; set; }
Property Value
System.Object
Remarks
The global database can't be deleted when deletion protection is enabled.
Engine
The name of the database engine to be used for this DB cluster.
public virtual string Engine { get; set; }
Property Value
System.String
Remarks
If this property isn't specified, the database engine is derived from the source DB cluster specified by the SourceDBClusterIdentifier
property.
If the SourceDBClusterIdentifier
property isn't specified, this property is required. If the SourceDBClusterIdentifier
property is specified, make sure this property isn't specified.
EngineVersion
The engine version of the Aurora global database.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
GlobalClusterIdentifier
The cluster identifier of the global database cluster.
public virtual string GlobalClusterIdentifier { get; set; }
Property Value
System.String
Remarks
SourceDbClusterIdentifier
The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
public virtual string SourceDbClusterIdentifier { get; set; }
Property Value
System.String
Remarks
If the Engine
property isn't specified, this property is required. If the Engine
property is specified, make sure this property isn't specified.
StorageEncrypted
The storage encryption setting for the global database cluster.
public virtual object StorageEncrypted { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>