Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.

Initializers 

using AlibabaCloud.SDK.ROS.CDK.Polardb;
new DBCluster(Construct Scope, string Id, DBClusterProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props DBClusterProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired

EnableResourcePropertyConstraintOptional

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
AddCondition No description.
AddCount No description.
AddDependency No description.
AddResourceDesc No description.
ApplyRemovalPolicy No description.
GetAtt No description.
SetMetadata No description.

ToString 

private string ToString()

Returns a string representation of this construct.

Synthesize 

private void Synthesize(ISynthesisSession Session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

SessionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition 

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount 

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency 

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc 

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy 

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

GetAtt 

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata 

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.

IsConstruct 

using AlibabaCloud.SDK.ROS.CDK.Polardb;
DBCluster.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrClusterConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ClusterConnectionString: The cluster connection string of the db cluster.
AttrClusterEndpointId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
AttrColdStorageInstanceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ColdStorageInstanceId: The ID of the cold storage instance.
AttrCustomConnectionStrings AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
AttrCustomEndpointIds AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
AttrDbClusterDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterDescription: The description of the db cluster.
AttrDbClusterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
AttrDbNodeIds AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DBNodeIds: The ID list of cluster nodes.
AttrOrderId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute OrderId: The Order ID.
AttrPrimaryConnectionString AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PrimaryConnectionString: The primary connection string of the db cluster.
AttrPrimaryConnectionStrings AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
AttrPrimaryEndpointId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
AttrPrimaryEndpointIds AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.

NodeRequired 

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

RefRequired 

public string Ref { get; }
  • Type: string

StackRequired 

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

ResourceOptional 

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrClusterConnectionStringRequired 

public IResolvable AttrClusterConnectionString { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ClusterConnectionString: The cluster connection string of the db cluster.

AttrClusterEndpointIdRequired 

public IResolvable AttrClusterEndpointId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.

AttrColdStorageInstanceIdRequired 

public IResolvable AttrColdStorageInstanceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ColdStorageInstanceId: The ID of the cold storage instance.

AttrCustomConnectionStringsRequired 

public IResolvable AttrCustomConnectionStrings { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CustomConnectionStrings: The custom connection strings of the db cluster.

AttrCustomEndpointIdsRequired 

public IResolvable AttrCustomEndpointIds { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.

AttrDbClusterDescriptionRequired 

public IResolvable AttrDbClusterDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBClusterDescription: The description of the db cluster.

AttrDbClusterIdRequired 

public IResolvable AttrDbClusterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.

AttrDbNodeIdsRequired 

public IResolvable AttrDbNodeIds { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DBNodeIds: The ID list of cluster nodes.

AttrOrderIdRequired 

public IResolvable AttrOrderId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute OrderId: The Order ID.

AttrPrimaryConnectionStringRequired 

public IResolvable AttrPrimaryConnectionString { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PrimaryConnectionString: The primary connection string of the db cluster.

AttrPrimaryConnectionStringsRequired 

public IResolvable AttrPrimaryConnectionStrings { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.

AttrPrimaryEndpointIdRequired 

public IResolvable AttrPrimaryEndpointId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.

AttrPrimaryEndpointIdsRequired 

public IResolvable AttrPrimaryEndpointIds { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.