Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBCluster.

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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc 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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

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.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
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.
AttrArn object Attribute Arn: The Alibaba Cloud Resource Name (ARN).
AttrClusterConnectionString object Attribute ClusterConnectionString: The cluster connection string of the db cluster.
AttrClusterEndpointId object Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
AttrColdStorageInstanceId object Attribute ColdStorageInstanceId: The ID of the cold storage instance.
AttrCustomConnectionStrings object Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
AttrCustomEndpointIds object Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
AttrDbClusterDescription object Attribute DBClusterDescription: The description of the db cluster.
AttrDbClusterId object Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
AttrDbNodeIds object Attribute DBNodeIds: The ID list of cluster nodes.
AttrOrderId object Attribute OrderId: The Order ID.
AttrPrimaryConnectionString object Attribute PrimaryConnectionString: The primary connection string of the db cluster.
AttrPrimaryConnectionStrings object Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
AttrPrimaryEndpointId object Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
AttrPrimaryEndpointIds object Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.
Props DBClusterProps No description.

NodeRequired

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

The construct tree node associated with this construct.


EnvRequired

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


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

AttrArnRequired

public object AttrArn { get; }
  • Type: object

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


AttrClusterConnectionStringRequired

public object AttrClusterConnectionString { get; }
  • Type: object

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


AttrClusterEndpointIdRequired

public object AttrClusterEndpointId { get; }
  • Type: object

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


AttrColdStorageInstanceIdRequired

public object AttrColdStorageInstanceId { get; }
  • Type: object

Attribute ColdStorageInstanceId: The ID of the cold storage instance.


AttrCustomConnectionStringsRequired

public object AttrCustomConnectionStrings { get; }
  • Type: object

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


AttrCustomEndpointIdsRequired

public object AttrCustomEndpointIds { get; }
  • Type: object

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


AttrDbClusterDescriptionRequired

public object AttrDbClusterDescription { get; }
  • Type: object

Attribute DBClusterDescription: The description of the db cluster.


AttrDbClusterIdRequired

public object AttrDbClusterId { get; }
  • Type: object

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


AttrDbNodeIdsRequired

public object AttrDbNodeIds { get; }
  • Type: object

Attribute DBNodeIds: The ID list of cluster nodes.


AttrOrderIdRequired

public object AttrOrderId { get; }
  • Type: object

Attribute OrderId: The Order ID.


AttrPrimaryConnectionStringRequired

public object AttrPrimaryConnectionString { get; }
  • Type: object

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


AttrPrimaryConnectionStringsRequired

public object AttrPrimaryConnectionStrings { get; }
  • Type: object

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


AttrPrimaryEndpointIdRequired

public object AttrPrimaryEndpointId { get; }
  • Type: object

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


AttrPrimaryEndpointIdsRequired

public object AttrPrimaryEndpointIds { get; }
  • Type: object

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


PropsRequired

public DBClusterProps Props { get; }