alicloudroscdkpolardb

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

Aliyun ROS POLARDB Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as POLARDB from '@alicloud/ros-cdk-polardb';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AITask_IsConstruct

func AITask_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func AccountPrivilege_IsConstruct

func AccountPrivilege_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Account_IsConstruct

func Account_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Backup_IsConstruct added in v1.3.0

func Backup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBClusterAccessWhiteList_IsConstruct

func DBClusterAccessWhiteList_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBClusterEndpointAddress_IsConstruct

func DBClusterEndpointAddress_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBClusterEndpoint_IsConstruct

func DBClusterEndpoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBCluster_IsConstruct

func DBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DBNodes_IsConstruct

func DBNodes_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func Database_IsConstruct

func Database_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func GlobalDatabaseNetwork_IsConstruct

func GlobalDatabaseNetwork_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewAITask_Override

func NewAITask_Override(a AITask, scope alicloudroscdkcore.Construct, id *string, props *AITaskProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewAccountPrivilege_Override

func NewAccountPrivilege_Override(a AccountPrivilege, scope alicloudroscdkcore.Construct, id *string, props *AccountPrivilegeProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewAccount_Override

func NewAccount_Override(a Account, scope alicloudroscdkcore.Construct, id *string, props *AccountProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewBackup_Override added in v1.3.0

func NewBackup_Override(b Backup, scope alicloudroscdkcore.Construct, id *string, props *BackupProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBClusterAccessWhiteList_Override

func NewDBClusterAccessWhiteList_Override(d DBClusterAccessWhiteList, scope alicloudroscdkcore.Construct, id *string, props *DBClusterAccessWhiteListProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBClusterEndpointAddress_Override

func NewDBClusterEndpointAddress_Override(d DBClusterEndpointAddress, scope alicloudroscdkcore.Construct, id *string, props *DBClusterEndpointAddressProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBClusterEndpoint_Override

func NewDBClusterEndpoint_Override(d DBClusterEndpoint, scope alicloudroscdkcore.Construct, id *string, props *DBClusterEndpointProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBCluster_Override

func NewDBCluster_Override(d DBCluster, scope alicloudroscdkcore.Construct, id *string, props *DBClusterProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDBNodes_Override

func NewDBNodes_Override(d DBNodes, scope alicloudroscdkcore.Construct, id *string, props *DBNodesProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDatabase_Override

func NewDatabase_Override(d Database, scope alicloudroscdkcore.Construct, id *string, props *DatabaseProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewGlobalDatabaseNetwork_Override

func NewGlobalDatabaseNetwork_Override(g GlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewParameterGroup_Override

func NewParameterGroup_Override(p ParameterGroup, scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosAITask_Override

func NewRosAITask_Override(r RosAITask, scope alicloudroscdkcore.Construct, id *string, props *RosAITaskProps, enableResourcePropertyConstraint *bool)

func NewRosAccountPrivilege_Override

func NewRosAccountPrivilege_Override(r RosAccountPrivilege, scope alicloudroscdkcore.Construct, id *string, props *RosAccountPrivilegeProps, enableResourcePropertyConstraint *bool)

func NewRosAccount_Override

func NewRosAccount_Override(r RosAccount, scope alicloudroscdkcore.Construct, id *string, props *RosAccountProps, enableResourcePropertyConstraint *bool)

func NewRosBackup_Override added in v1.3.0

func NewRosBackup_Override(r RosBackup, scope alicloudroscdkcore.Construct, id *string, props *RosBackupProps, enableResourcePropertyConstraint *bool)

func NewRosDBClusterAccessWhiteList_Override

func NewRosDBClusterAccessWhiteList_Override(r RosDBClusterAccessWhiteList, scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterAccessWhiteListProps, enableResourcePropertyConstraint *bool)

func NewRosDBClusterEndpointAddress_Override

func NewRosDBClusterEndpointAddress_Override(r RosDBClusterEndpointAddress, scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterEndpointAddressProps, enableResourcePropertyConstraint *bool)

func NewRosDBClusterEndpoint_Override

func NewRosDBClusterEndpoint_Override(r RosDBClusterEndpoint, scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterEndpointProps, enableResourcePropertyConstraint *bool)

func NewRosDBCluster_Override

func NewRosDBCluster_Override(r RosDBCluster, scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterProps, enableResourcePropertyConstraint *bool)

func NewRosDBNodes_Override

func NewRosDBNodes_Override(r RosDBNodes, scope alicloudroscdkcore.Construct, id *string, props *RosDBNodesProps, enableResourcePropertyConstraint *bool)

func NewRosDatabase_Override

func NewRosDatabase_Override(r RosDatabase, scope alicloudroscdkcore.Construct, id *string, props *RosDatabaseProps, enableResourcePropertyConstraint *bool)

func NewRosGlobalDatabaseNetwork_Override

func NewRosGlobalDatabaseNetwork_Override(r RosGlobalDatabaseNetwork, scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool)

func NewRosParameterGroup_Override

func NewRosParameterGroup_Override(r RosParameterGroup, scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupProps, enableResourcePropertyConstraint *bool)

func ParameterGroup_IsConstruct

func ParameterGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosAITask_IsConstruct

func RosAITask_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosAITask_IsRosElement

func RosAITask_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosAITask_IsRosResource

func RosAITask_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosAITask_ROS_RESOURCE_TYPE_NAME

func RosAITask_ROS_RESOURCE_TYPE_NAME() *string

func RosAccountPrivilege_IsConstruct

func RosAccountPrivilege_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosAccountPrivilege_IsRosElement

func RosAccountPrivilege_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosAccountPrivilege_IsRosResource

func RosAccountPrivilege_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosAccountPrivilege_ROS_RESOURCE_TYPE_NAME

func RosAccountPrivilege_ROS_RESOURCE_TYPE_NAME() *string

func RosAccount_IsConstruct

func RosAccount_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosAccount_IsRosElement

func RosAccount_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosAccount_IsRosResource

func RosAccount_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosAccount_ROS_RESOURCE_TYPE_NAME

func RosAccount_ROS_RESOURCE_TYPE_NAME() *string

func RosBackup_IsConstruct added in v1.3.0

func RosBackup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosBackup_IsRosElement added in v1.3.0

func RosBackup_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosBackup_IsRosResource added in v1.3.0

func RosBackup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosBackup_ROS_RESOURCE_TYPE_NAME added in v1.3.0

func RosBackup_ROS_RESOURCE_TYPE_NAME() *string

func RosDBClusterAccessWhiteList_IsConstruct

func RosDBClusterAccessWhiteList_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBClusterAccessWhiteList_IsRosElement

func RosDBClusterAccessWhiteList_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDBClusterAccessWhiteList_IsRosResource

func RosDBClusterAccessWhiteList_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBClusterAccessWhiteList_ROS_RESOURCE_TYPE_NAME

func RosDBClusterAccessWhiteList_ROS_RESOURCE_TYPE_NAME() *string

func RosDBClusterEndpointAddress_IsConstruct

func RosDBClusterEndpointAddress_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBClusterEndpointAddress_IsRosElement

func RosDBClusterEndpointAddress_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDBClusterEndpointAddress_IsRosResource

func RosDBClusterEndpointAddress_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBClusterEndpointAddress_ROS_RESOURCE_TYPE_NAME

func RosDBClusterEndpointAddress_ROS_RESOURCE_TYPE_NAME() *string

func RosDBClusterEndpoint_IsConstruct

func RosDBClusterEndpoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBClusterEndpoint_IsRosElement

func RosDBClusterEndpoint_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDBClusterEndpoint_IsRosResource

func RosDBClusterEndpoint_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBClusterEndpoint_ROS_RESOURCE_TYPE_NAME

func RosDBClusterEndpoint_ROS_RESOURCE_TYPE_NAME() *string

func RosDBCluster_IsConstruct

func RosDBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBCluster_IsRosElement

func RosDBCluster_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDBCluster_IsRosResource

func RosDBCluster_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBCluster_ROS_RESOURCE_TYPE_NAME

func RosDBCluster_ROS_RESOURCE_TYPE_NAME() *string

func RosDBNodes_IsConstruct

func RosDBNodes_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDBNodes_IsRosElement

func RosDBNodes_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDBNodes_IsRosResource

func RosDBNodes_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDBNodes_ROS_RESOURCE_TYPE_NAME

func RosDBNodes_ROS_RESOURCE_TYPE_NAME() *string

func RosDatabase_IsConstruct

func RosDatabase_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDatabase_IsRosElement

func RosDatabase_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDatabase_IsRosResource

func RosDatabase_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDatabase_ROS_RESOURCE_TYPE_NAME

func RosDatabase_ROS_RESOURCE_TYPE_NAME() *string

func RosGlobalDatabaseNetwork_IsConstruct

func RosGlobalDatabaseNetwork_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosGlobalDatabaseNetwork_IsRosElement

func RosGlobalDatabaseNetwork_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosGlobalDatabaseNetwork_IsRosResource

func RosGlobalDatabaseNetwork_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosGlobalDatabaseNetwork_ROS_RESOURCE_TYPE_NAME

func RosGlobalDatabaseNetwork_ROS_RESOURCE_TYPE_NAME() *string

func RosParameterGroup_IsConstruct

func RosParameterGroup_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosParameterGroup_IsRosElement

func RosParameterGroup_IsRosElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosParameterGroup_IsRosResource

func RosParameterGroup_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosParameterGroup_ROS_RESOURCE_TYPE_NAME

func RosParameterGroup_ROS_RESOURCE_TYPE_NAME() *string

Types

type AITask

type AITask interface {
	alicloudroscdkcore.Resource
	IAITask
	// Attribute DBClusterId: The ID of the DB cluster.
	AttrDbClusterId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *AITaskProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::AITask`, which is used to enable the PolarDB for AI feature.

func NewAITask

func NewAITask(scope alicloudroscdkcore.Construct, id *string, props *AITaskProps, enableResourcePropertyConstraint *bool) AITask

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type AITaskProps

type AITaskProps struct {
	// Property dbClusterId: The ID of the DB cluster.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property password: The password of the database account that enables the PolarDB for AI function is required.
	Password interface{} `field:"required" json:"password" yaml:"password"`
	// Property username: The database account that enables the PolarDB for AI function is required.
	Username interface{} `field:"required" json:"username" yaml:"username"`
	// Property nodeType: The type of the node.
	//
	// Valid values:
	// DLNode: AI node(default).
	// SearchNode: Search ai node.
	NodeType interface{} `field:"optional" json:"nodeType" yaml:"nodeType"`
}

Properties for defining a `AITask`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-aitask

type Account

type Account interface {
	alicloudroscdkcore.Resource
	IAccount
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *AccountProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::Account`, which is used to create a database account for a specified PolarDB cluster.

func NewAccount

func NewAccount(scope alicloudroscdkcore.Construct, id *string, props *AccountProps, enableResourcePropertyConstraint *bool) Account

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type AccountPrivilege

type AccountPrivilege interface {
	alicloudroscdkcore.Resource
	IAccountPrivilege
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *AccountPrivilegeProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::AccountPrivilege`, which is used to grant access permissions on one or more databases in a specified ApsaraDB for POLARDB cluster to a standard account.

func NewAccountPrivilege

func NewAccountPrivilege(scope alicloudroscdkcore.Construct, id *string, props *AccountPrivilegeProps, enableResourcePropertyConstraint *bool) AccountPrivilege

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type AccountPrivilegeProps

type AccountPrivilegeProps struct {
	// Property accountName: The name of the database account to be granted access permissions.
	AccountName interface{} `field:"required" json:"accountName" yaml:"accountName"`
	// Property accountPrivilege: The permissions of the database account on the database.
	//
	// Valid values:
	// - ReadWrite: has read and write permissions on the database.
	// - ReadOnly: has the read-only permission on the database.
	// - DMLOnly: runs only data manipulation language (DML) statements.
	// - DDLOnly: runs only data definition language (DDL) statements.
	// The number of account permissions specified by the AccountPrivilege parameter must be the same as that of database names specified by the DBName parameter. Each account permission must correspond to a database name in sequence.
	// Separate multiple permissions with a comma (,).
	AccountPrivilege interface{} `field:"required" json:"accountPrivilege" yaml:"accountPrivilege"`
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster to which a database account belongs.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property dbName: The name of the database whose access permissions are to be granted to the database account.
	//
	// You can grant access permissions on one or more databases to the database account.
	// Separate multiple databases with a comma (,).
	DbName interface{} `field:"required" json:"dbName" yaml:"dbName"`
}

Properties for defining a `AccountPrivilege`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-accountprivilege

type AccountProps

type AccountProps struct {
	// Property accountName: The name of the database account.
	//
	// The name must comply with the following rules:
	// - It must start with a lowercase letter and consist of lowercase letters, digits, and underscores (_).
	// - It can be up to 16 characters in length.
	AccountName interface{} `field:"required" json:"accountName" yaml:"accountName"`
	// Property accountPassword: The password of the database account.
	//
	// The password must comply with the following rules:
	// - It must consist of uppercase letters, lowercase letters, digits, and special characters.
	// - Special characters include exclamation points (!), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).
	// - It must be 8 to 32 characters in length.
	AccountPassword interface{} `field:"required" json:"accountPassword" yaml:"accountPassword"`
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database account is to be created.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property accountDescription: The description of the database account.
	//
	// The description must comply with the following rules:
	// - It cannot start with http:\/\/ or https:\/\/.
	// - It must be 2 to 256 characters in length.
	AccountDescription interface{} `field:"optional" json:"accountDescription" yaml:"accountDescription"`
	// Property accountPrivilege: The permissions of the database account on the database.
	//
	// Valid values:
	// ReadWrite: has read and write permissions on the database.
	// ReadOnly: has the read-only permission on the database.
	// DMLOnly: runs only data manipulation language (DML) statements.
	// DDLOnly: runs only data definition language (DDL) statements.
	// ReadIndex: has read and index permissions on the database.
	// Default value: ReadWrite.
	// Separate multiple permissions with a comma (,).
	AccountPrivilege interface{} `field:"optional" json:"accountPrivilege" yaml:"accountPrivilege"`
	// Property accountType: The type of the database account.
	//
	// Valid values:
	// - Normal: standard account
	// - Super: privileged account
	// Default value: Super.
	// Currently, POLARDB for PostgreSQL and POLARDB compatible with Oracle do not support standard accounts.
	// You can create only one privileged account for an ApsaraDB for POLARDB cluster.
	AccountType interface{} `field:"optional" json:"accountType" yaml:"accountType"`
	// Property dbName: The name of the database whose access permissions are to be granted to the database account.
	//
	// Separate multiple databases with a comma (,).
	DbName interface{} `field:"optional" json:"dbName" yaml:"dbName"`
	// Property privForAllDb: Whether to grant permissions to all libraries in the current cluster and any libraries that will be added in the future.
	//
	// Valid values:
	// - 0 (default)): Not authorized.
	// - 1: Authorization.
	PrivForAllDb interface{} `field:"optional" json:"privForAllDb" yaml:"privForAllDb"`
}

Properties for defining a `Account`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-account

type Backup added in v1.3.0

type Backup interface {
	alicloudroscdkcore.Resource
	IBackup
	// Attribute BackupJobId: The ID of the backup set.
	AttrBackupJobId() interface{}
	// Attribute DBClusterId: The ID of the cluster.
	AttrDbClusterId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *BackupProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

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

func NewBackup added in v1.3.0

func NewBackup(scope alicloudroscdkcore.Construct, id *string, props *BackupProps, enableResourcePropertyConstraint *bool) Backup

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type BackupProps added in v1.3.0

type BackupProps struct {
	// Property dbClusterId: The cluster ID.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
}

Properties for defining a `Backup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-backup

type DBCluster

type DBCluster interface {
	alicloudroscdkcore.Resource
	IDBCluster
	// Attribute ClusterConnectionString: The cluster connection string of the db cluster.
	AttrClusterConnectionString() interface{}
	// Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
	AttrClusterEndpointId() interface{}
	// Attribute ColdStorageInstanceId: The ID of the cold storage instance.
	AttrColdStorageInstanceId() interface{}
	// Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
	AttrCustomConnectionStrings() interface{}
	// Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
	AttrCustomEndpointIds() interface{}
	// Attribute DBClusterDescription: The description of the db cluster.
	AttrDbClusterDescription() interface{}
	// Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
	AttrDbClusterId() interface{}
	// Attribute DBNodeIds: The ID list of cluster nodes.
	AttrDbNodeIds() interface{}
	// Attribute OrderId: The Order ID.
	AttrOrderId() interface{}
	// Attribute PrimaryConnectionString: The primary connection string of the db cluster.
	AttrPrimaryConnectionString() interface{}
	// Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
	AttrPrimaryConnectionStrings() interface{}
	// Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
	AttrPrimaryEndpointId() interface{}
	// Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.
	AttrPrimaryEndpointIds() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DBClusterProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

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

func NewDBCluster

func NewDBCluster(scope alicloudroscdkcore.Construct, id *string, props *DBClusterProps, enableResourcePropertyConstraint *bool) DBCluster

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClusterAccessWhiteList

type DBClusterAccessWhiteList interface {
	alicloudroscdkcore.Resource
	IDBClusterAccessWhiteList
	// Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist is to be modified.
	AttrDbClusterId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DBClusterAccessWhiteListProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::DBClusterAccessWhiteList`, which is used to modify the list of IP addresses that are allowed to access an ApsaraDB for POLARDB cluster.

func NewDBClusterAccessWhiteList

func NewDBClusterAccessWhiteList(scope alicloudroscdkcore.Construct, id *string, props *DBClusterAccessWhiteListProps, enableResourcePropertyConstraint *bool) DBClusterAccessWhiteList

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClusterAccessWhiteListProps

type DBClusterAccessWhiteListProps struct {
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist is to be modified.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property securityIps: The IP addresses to be added to the IP address whitelist group to be modified.
	//
	// Each
	// whitelist group can contain a maximum of 1,000 IP addresses. Separate multiple IP
	// addresses with a comma (,). The following two formats are supported:
	// IP address: for example, 10.23.12.24.
	// Classless inter-domain routing (CIDR) block: for example, 10.23.12.24\/24, where the
	// suffix \/24 indicates the number of bits for the prefix of the IP address. The suffix
	// ranges from 1 to 32.
	SecurityIps interface{} `field:"required" json:"securityIps" yaml:"securityIps"`
	// Property dbClusterIpArrayName: The name of the IP address whitelist group.
	//
	// If you do not specify this parameter,
	// the Default whitelist group is modified by default.
	// Note You can create up to 50 whitelist groups for an ApsaraDB for POLARDB cluster.
	DbClusterIpArrayName interface{} `field:"optional" json:"dbClusterIpArrayName" yaml:"dbClusterIpArrayName"`
}

Properties for defining a `DBClusterAccessWhiteList`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusteraccesswhitelist

type DBClusterEndpoint

type DBClusterEndpoint interface {
	alicloudroscdkcore.Resource
	IDBClusterEndpoint
	// Attribute Addresses: The address items of the db cluster endpoint.
	AttrAddresses() interface{}
	// Attribute ConnectionString: The first connection string of the db cluster endpoint.
	AttrConnectionString() interface{}
	// Attribute DBEndpointId: DB cluster endpoint ID.
	//
	// E.g. pe-xxxxxxxx.
	AttrDbEndpointId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DBClusterEndpointProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::DBClusterEndpoint`, which is used to create a custom endpoint for a PolarDB cluster.

func NewDBClusterEndpoint

func NewDBClusterEndpoint(scope alicloudroscdkcore.Construct, id *string, props *DBClusterEndpointProps, enableResourcePropertyConstraint *bool) DBClusterEndpoint

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClusterEndpointAddress

type DBClusterEndpointAddress interface {
	alicloudroscdkcore.Resource
	IDBClusterEndpointAddress
	// Attribute Address: The details of the endpoint address.
	AttrAddress() interface{}
	// Attribute ConnectionString: The connection string of the endpoint address.
	AttrConnectionString() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DBClusterEndpointAddressProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::DBClusterEndpointAddress`, which is used to create a public endpoint for an Apsara PolarDB cluster.

The public endpoint can be a primary endpoint, the default cluster endpoint, or a custom cluster endpoint.

func NewDBClusterEndpointAddress

func NewDBClusterEndpointAddress(scope alicloudroscdkcore.Construct, id *string, props *DBClusterEndpointAddressProps, enableResourcePropertyConstraint *bool) DBClusterEndpointAddress

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBClusterEndpointAddressProps

type DBClusterEndpointAddressProps struct {
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property dbEndpointId: The ID of the cluster connection point.
	DbEndpointId interface{} `field:"required" json:"dbEndpointId" yaml:"dbEndpointId"`
	// Property connectionStringPrefix: The prefix of the connection string.
	//
	// The prefix must comply with the following rules:
	// It must start with a letter and consist of lowercase letters, digits, and hyphens(-), cannot end with a dash.
	// The length is 6~30 characters.
	ConnectionStringPrefix interface{} `field:"optional" json:"connectionStringPrefix" yaml:"connectionStringPrefix"`
	// Property netType: The network type of the connection string.
	//
	// If set to Public, ROS will create, modify and delete Public address for you.
	// If set to Private, ROS will only modify Private address for you.
	// Default to Public.
	NetType interface{} `field:"optional" json:"netType" yaml:"netType"`
}

Properties for defining a `DBClusterEndpointAddress`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusterendpointaddress

type DBClusterEndpointProps

type DBClusterEndpointProps struct {
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a custom connection point is to be created.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property autoAddNewNodes: Specifies whether a newly added node is automatically added to this connection point.
	//
	// Valid values: Enable, Disable.
	// Default value: Disable.
	AutoAddNewNodes interface{} `field:"optional" json:"autoAddNewNodes" yaml:"autoAddNewNodes"`
	// Property endpointConfig:.
	EndpointConfig interface{} `field:"optional" json:"endpointConfig" yaml:"endpointConfig"`
	// Property endpointType: The type of the cluster connection point.
	//
	// Set this parameter to Custom.
	EndpointType interface{} `field:"optional" json:"endpointType" yaml:"endpointType"`
	// Property nodes: The nodes to be added to this connection point to process read requests from this connection point.
	//
	// Add at least two nodes.
	// If you do not specify this parameter, all nodes of the cluster are added to this connection point by default.
	Nodes interface{} `field:"optional" json:"nodes" yaml:"nodes"`
	// Property readWriteMode: The read\/write mode of the cluster connection point.
	//
	// Valid values:
	// ReadWrite: receives and forwards read and write requests (automatic read-write splitting).
	// ReadOnly: receives and forwards only read requests.
	// Default value: ReadOnly.
	ReadWriteMode interface{} `field:"optional" json:"readWriteMode" yaml:"readWriteMode"`
}

Properties for defining a `DBClusterEndpoint`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusterendpoint

type DBClusterProps

type DBClusterProps struct {
	// Property dbNodeClass: The node specifications of the cluster.
	//
	// For more information, see Specifications and pricing.
	DbNodeClass interface{} `field:"required" json:"dbNodeClass" yaml:"dbNodeClass"`
	// Property dbType: Database type, value: MySQL PostgreSQL Oracle.
	DbType interface{} `field:"required" json:"dbType" yaml:"dbType"`
	// Property dbVersion: The version of the database.
	//
	// Valid values:
	// MySQL: 5.6, 5.7 or 8.0
	// PostgreSQL: 11, 14, 15
	// Oracle: 11, 14.
	DbVersion interface{} `field:"required" json:"dbVersion" yaml:"dbVersion"`
	// Property payType: The billing method of the cluster.
	//
	// Valid values:
	// Postpaid: pay-as-you-go
	// Prepaid: subscription.
	PayType interface{} `field:"required" json:"payType" yaml:"payType"`
	// Property allowShutDown: Whether to turn on No activity pause.
	//
	// The default is false.
	AllowShutDown interface{} `field:"optional" json:"allowShutDown" yaml:"allowShutDown"`
	// Property architecture: The architecture of CPU.
	//
	// Valid values:
	// X86
	// ARM.
	Architecture interface{} `field:"optional" json:"architecture" yaml:"architecture"`
	// Property autoRenewPeriod: Set the cluster auto renewal time.
	//
	// Valid values: 1, 2, 3, 6, 12, 24, 36. Default to 1.
	AutoRenewPeriod interface{} `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
	// Property backupRetentionPolicyOnClusterDeletion: The backup set retention policy when deleting a cluster, the value range is as follows: ALL: Keep all backups permanently.
	//
	// LATEST: Permanently keep the last backup (automatic backup before deletion).
	// NONE: The backup set is not retained when the cluster is deleted.
	// When creating a cluster, the default value is NONE, that is, the backup set is not retained when the cluster is deleted.
	// Note: This parameter takes effect only when the value of DBType is MySQL.
	BackupRetentionPolicyOnClusterDeletion interface{} `field:"optional" json:"backupRetentionPolicyOnClusterDeletion" yaml:"backupRetentionPolicyOnClusterDeletion"`
	// Property cloneDataPoint: The time point of data to be cloned.
	//
	// Valid values:
	// LATEST: clones data of the latest time point.
	// <BackupID>: clones historical backup data. Specify the ID of the specific backup set.
	// <Timestamp>: clones data of a historical time point. Specify the specific time in
	// the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
	// Default value: LATEST.
	// Note
	// This parameter takes effect only when the DBType parameter is set to MySQL, the DBVersion parameter is set to 5.6, and the CreationOption parameter is set to CloneFromRDS or CloneFromPolarDB.
	// If the CreationOption parameter is set to CloneFromRDS, the value of this parameter must be LATEST.
	CloneDataPoint interface{} `field:"optional" json:"cloneDataPoint" yaml:"cloneDataPoint"`
	// Property clusterNetworkType: The network type of the cluster.
	//
	// Currently, only VPC is supported. Default value: VPC.
	ClusterNetworkType interface{} `field:"optional" json:"clusterNetworkType" yaml:"clusterNetworkType"`
	// Property coldStorageOption: The option of cold storage.
	ColdStorageOption interface{} `field:"optional" json:"coldStorageOption" yaml:"coldStorageOption"`
	// Property creationCategory: Cluster series.
	//
	// The value could be Normal (standard version), Basic, ArchiveNormal, NormalMultimaster and SENormal.
	CreationCategory interface{} `field:"optional" json:"creationCategory" yaml:"creationCategory"`
	// Property creationOption: The method for creating an ApsaraDB for POLARDB cluster.
	//
	// Valid values:
	// Normal: creates an ApsaraDB for POLARDB cluster.
	// CloneFromPolarDB: clones data from an existing ApsaraDB for POLARDB cluster to a new ApsaraDB for POLARDB cluster.
	// CloneFromRDS: clones data from an existing ApsaraDB for RDS instance to a new ApsaraDB
	// for POLARDB cluster.
	// MigrationFromRDS: migrates data from an existing ApsaraDB for RDS instance to a new ApsaraDB for POLARDB cluster. The created ApsaraDB for POLARDB cluster is in read-only mode and has binary logs enabled by default.
	// CreateGdnStandby: Create a secondary cluster.
	// RecoverFromRecyclebin: Recovers data from the freed PolarDB cluster to the new PolarDB cluster.
	// UpgradeFromPolarDB: Upgrade migration from PolarDB.
	// Default value: Normal.
	// Note:
	// When DBType is MySQL and DBVersion is 5.6, this parameter can be specified as CloneFromRDS or MigrationFromRDS.
	// When DBType is MySQL and DBVersion is 8.0, this parameter can be specified as CreateGdnStandby.
	CreationOption interface{} `field:"optional" json:"creationOption" yaml:"creationOption"`
	// Property dbClusterDescription: The description of the cluster.
	//
	// The description must comply with the following rules:
	// It must start with a Chinese character or an English letter.
	// It can contain Chinese and English characters, digits, underscores (_), and hyphens (-).
	// It cannot start with http:\/\/ or https:\/\/.
	// It must be 2 to 256 characters in length.
	DbClusterDescription interface{} `field:"optional" json:"dbClusterDescription" yaml:"dbClusterDescription"`
	// Property dbClusterParameters: Modifies the parameters of a the PolarDB cluster.
	DbClusterParameters interface{} `field:"optional" json:"dbClusterParameters" yaml:"dbClusterParameters"`
	// Property dbMinorVersion: The minor version of the cluster.
	//
	// Valid values:
	// 8.0.2
	// 8.0.1
	// This parameter is valid only when the DBType parameter is set to MySQL and the DBVersion parameter is set to 8.0.
	DbMinorVersion interface{} `field:"optional" json:"dbMinorVersion" yaml:"dbMinorVersion"`
	// Property dbNodeNum: The number of Standard Edition nodes.
	//
	// Default value: 1. Valid values:
	// 1: only one primary node.
	// 2: one read-only node and one primary node.
	DbNodeNum interface{} `field:"optional" json:"dbNodeNum" yaml:"dbNodeNum"`
	// Property defaultTimeZone: Set up a time zone (UTC), the value range is as follows: System:  The default time zone is the same as the time zone where the region is located.
	//
	// This is default value.
	// Other pickable value range is from -12:00 to +13:00, for example, 00:00.
	// Note: This parameter takes effect only when DBType is MySQL.
	DefaultTimeZone interface{} `field:"optional" json:"defaultTimeZone" yaml:"defaultTimeZone"`
	// Property deletionProtection: Specifies whether to enable the release protection feature for the cluster.
	//
	// Default is false.
	DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
	// Property gdnId: The ID of the Global Database Network (GDN).
	//
	// Note: This parameter is required when the CreationOption is CreateGdnStandby.
	GdnId interface{} `field:"optional" json:"gdnId" yaml:"gdnId"`
	// Property hotStandbyCluster: Specifies whether to enable the hot standby storage cluster feature.
	//
	// Default value: ON. Valid values:
	// ON: enables the hot standby storage cluster feature.
	// OFF: disables the hot standby storage cluster feature
	// STANDBY: enables the hot standby storage cluster feature only for Standard Edition clusters.
	// The default value for Standard Edition clusters is STANDBY.
	HotStandbyCluster interface{} `field:"optional" json:"hotStandbyCluster" yaml:"hotStandbyCluster"`
	// Property loosePolarLogBin: Enable the Binlog function, the value range is as follows: ON: The cluster enables the Binlog function OFF: The cluster disables the Binlog function This parameter takes effect only when the parameter DBType is MySQL.
	LoosePolarLogBin interface{} `field:"optional" json:"loosePolarLogBin" yaml:"loosePolarLogBin"`
	// Property looseXEngine: Enable the X-Engine storage engine function, the value range is as follows: ON: The cluster starts the X-Engine enginen OFF: The cluster shuts down the X-Engine engine This parameter takes effect only when the parameter CreationOption is not equal to CreateGdnStandby, DBType is MySQL and DBVersion is 8.0. The memory specification of the node with X-Engine enabled must be greater than or equal to 16 GB.
	LooseXEngine interface{} `field:"optional" json:"looseXEngine" yaml:"looseXEngine"`
	// Property looseXEngineUseMemoryPct: Set the ratio of enabling the X-Engine storage engine, an integer ranging from 10 to 90.
	//
	// This parameter takes effect only when the parameter LooseXEngine is ON.
	LooseXEngineUseMemoryPct interface{} `field:"optional" json:"looseXEngineUseMemoryPct" yaml:"looseXEngineUseMemoryPct"`
	// Property lowerCaseTableNames: Whether the table name is case sensitive, the value range is as follows: 1: Not case sensitive0: case sensitive The default value is 1.
	//
	// Note: This parameter takes effect only when the value of DBType is MySQL.
	LowerCaseTableNames interface{} `field:"optional" json:"lowerCaseTableNames" yaml:"lowerCaseTableNames"`
	// Property maintainTime: The maintainable time of the cluster: Format: HH: mmZ- HH: mmZ.
	//
	// Example: 16:00Z-17:00Z, which means 0 to 1 (UTC+08:00) for routine maintenance.
	MaintainTime interface{} `field:"optional" json:"maintainTime" yaml:"maintainTime"`
	// Property parameterGroupId: The ID of the parameter template.
	//
	// You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
	ParameterGroupId interface{} `field:"optional" json:"parameterGroupId" yaml:"parameterGroupId"`
	// Property period: The subscription period of the clusterIf PeriodUnit is month, the valid range is 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 If periodUnit is year, the valid range is 1, 2, 3.
	Period interface{} `field:"optional" json:"period" yaml:"period"`
	// Property periodUnit: The unit of the subscription duration.
	//
	// Valid values:
	// Month
	// Year
	// Default value: Month.
	PeriodUnit interface{} `field:"optional" json:"periodUnit" yaml:"periodUnit"`
	// Property provisionedIops: ESSD AutoPL preconfigured read and write IOPS for cloud disk.
	//
	// Possible values: 0-min {50,000, 1000* capacity - baseline performance}.
	// Baseline performance =min{1,800+50* capacity, 50000}.
	ProvisionedIops interface{} `field:"optional" json:"provisionedIops" yaml:"provisionedIops"`
	// Property proxyClass: The specifications of the Standard Edition PolarProxy.
	//
	// Valid values:
	// polar.maxscale.g2.medium.c: 2 cores
	// polar.maxscale.g2.large.c: 4 cores
	// polar.maxscale.g2.xlarge.c: 8 cores
	// polar.maxscale.g2.2xlarge.c: 16 cores
	// polar.maxscale.g2.3xlarge.c: 24 cores
	// polar.maxscale.g2.4xlarge.c: 32 cores
	// polar.maxscale.g2.8xlarge.c: 64 cores
	ProxyClass interface{} `field:"optional" json:"proxyClass" yaml:"proxyClass"`
	// Property proxyType: The type of PolarProxy.
	//
	// Default value: OFF. Valid values:
	// OFF: disables PolarProxy.
	// EXCLUSIVE: Dedicated Enterprise Edition
	// GENERAL: Standard Enterprise Edition.
	ProxyType interface{} `field:"optional" json:"proxyType" yaml:"proxyType"`
	// Property renewalStatus: The auto renewal status of the cluster Valid values: AutoRenewal: automatically renews the cluster.
	//
	// Normal: manually renews the cluster.
	// NotRenewal: does not renew the cluster.
	// Default value: Normal.
	// Note If this parameter is set to NotRenewal, the system does not send a reminder for expiration,
	// but only sends an SMS message three days before the cluster expires to remind you
	// that the cluster is not renewed.
	RenewalStatus interface{} `field:"optional" json:"renewalStatus" yaml:"renewalStatus"`
	// Property resourceGroupId: The ID of the resource group.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	// Property restartMasterNode: Whether to restart the master node.
	RestartMasterNode interface{} `field:"optional" json:"restartMasterNode" yaml:"restartMasterNode"`
	// Property scaleMax: Maximum limit of single-node scaling.
	ScaleMax interface{} `field:"optional" json:"scaleMax" yaml:"scaleMax"`
	// Property scaleMin: Minimum limit of single-node scaling.
	ScaleMin interface{} `field:"optional" json:"scaleMin" yaml:"scaleMin"`
	// Property scaleRoNumMax: The maximum scaling limit for the number of read-only nodes.
	ScaleRoNumMax interface{} `field:"optional" json:"scaleRoNumMax" yaml:"scaleRoNumMax"`
	// Property scaleRoNumMin: The minimum scaling limit for the number of read-only nodes.
	ScaleRoNumMin interface{} `field:"optional" json:"scaleRoNumMin" yaml:"scaleRoNumMin"`
	// Property securityGroupIds: The ID of the security group.
	//
	// You can add up to three security groups to a cluster.
	SecurityGroupIds interface{} `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
	// Property securityIpList: The whitelist of the Apsara PolarDB cluster.
	SecurityIpList interface{} `field:"optional" json:"securityIpList" yaml:"securityIpList"`
	// Property serverlessType: Serverless type.
	ServerlessType interface{} `field:"optional" json:"serverlessType" yaml:"serverlessType"`
	// Property sourceResourceId: The ID of the source RDS instance or source POLARDB cluster.
	//
	// Note
	// This parameter takes effect only when the DBType parameter is set to MySQL and the DBVersion parameter is set to 5.6.
	// This parameter is required if the CreationOption parameter is not set to Normal.
	SourceResourceId interface{} `field:"optional" json:"sourceResourceId" yaml:"sourceResourceId"`
	// Property standbyAz: The zone where the hot standby storage cluster is stored.
	//
	// This is valid for Standard Edition clusters of Multi-zone Edition.
	// This parameter takes effect only when the multi-zone data consistency feature is enabled.
	StandbyAz interface{} `field:"optional" json:"standbyAz" yaml:"standbyAz"`
	// Property storageAutoScale: Whether to enable automatic storage scale for standard version clusters.
	//
	// The value range is as follows:
	// Enable: Enable automatic storage scale.
	// Disable: Disable automatic storage scale.
	StorageAutoScale interface{} `field:"optional" json:"storageAutoScale" yaml:"storageAutoScale"`
	// Property storagePayType: The storage pay type.
	StoragePayType interface{} `field:"optional" json:"storagePayType" yaml:"storagePayType"`
	// Property storageSpace: The storage space that uses the subscription billing method.
	//
	// Unit: GB.
	// Valid values for PolarDB for MySQL Standard Edition: 20 to 32000.
	StorageSpace interface{} `field:"optional" json:"storageSpace" yaml:"storageSpace"`
	// Property storageType: The storage type.
	//
	// Valid values for Enterprise Edition:
	// PSL5
	// PSL4
	// Valid values for Standard Edition:
	// ESSDPL0
	// ESSDPL1
	// ESSDPL2
	// ESSDPL3
	// ESSDAUTOPL
	// This parameter is invalid for serverless clusters.
	StorageType interface{} `field:"optional" json:"storageType" yaml:"storageType"`
	// Property storageUpperBound: Set the upper limit of automatic scale of standard cluster storage, unit: GB.
	//
	// The maximum value is 32000.
	StorageUpperBound interface{} `field:"optional" json:"storageUpperBound" yaml:"storageUpperBound"`
	// Property strictConsistency: Specifies whether to enable the multi-zone data consistency feature.
	//
	// Valid values:
	// ON: enables the multi-zone data consistency feature, which is valid for Standard Edition clusters of Multi-zone Edition.
	// OFF: disables the multi-zone data consistency feature.
	StrictConsistency interface{} `field:"optional" json:"strictConsistency" yaml:"strictConsistency"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosDBCluster_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	// Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
	//
	// Valid values:
	// true: enable TDE
	// false: disable TDE (default)
	// Note: The parameter takes effect only when DBType is PostgreSQL or Oracle. You cannot disable TDE after it is enabled.
	TdeStatus interface{} `field:"optional" json:"tdeStatus" yaml:"tdeStatus"`
	// Property vpcId: The ID of the VPC to connect to.
	VpcId interface{} `field:"optional" json:"vpcId" yaml:"vpcId"`
	// Property vSwitchId: The ID of the VSwitch to connect to.
	VSwitchId interface{} `field:"optional" json:"vSwitchId" yaml:"vSwitchId"`
	// Property zoneId: The zone ID of the cluster.
	//
	// You can call the DescribeRegions operation to query available zones.
	ZoneId interface{} `field:"optional" json:"zoneId" yaml:"zoneId"`
}

Properties for defining a `DBCluster`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbcluster

type DBNodes

type DBNodes interface {
	alicloudroscdkcore.Resource
	IDBNodes
	// Attribute DBNodeIds: The ID list of added cluster nodes.
	AttrDbNodeIds() interface{}
	// Attribute OrderIds: The order ID list of added cluster nodes.
	AttrOrderIds() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DBNodesProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::DBNodes`, which is used to add nodes to a PolarDB cluster.

func NewDBNodes

func NewDBNodes(scope alicloudroscdkcore.Construct, id *string, props *DBNodesProps, enableResourcePropertyConstraint *bool) DBNodes

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DBNodesProps

type DBNodesProps struct {
	// Property amount: Number of nodes to be added to cluster.
	Amount interface{} `field:"required" json:"amount" yaml:"amount"`
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster to be added nodes to.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property dbNodeType: Node type.
	//
	// Ranges: RO|STANDBY|DLNode|RW.
	DbNodeType interface{} `field:"optional" json:"dbNodeType" yaml:"dbNodeType"`
	// Property endpointBindList: Address IDs that specifies the cluster connection address to which the new node should join.
	EndpointBindList interface{} `field:"optional" json:"endpointBindList" yaml:"endpointBindList"`
	// Property imciSwitch: Specifies whether to enable the In-Memory Column Index (IMCI) feature.
	ImciSwitch interface{} `field:"optional" json:"imciSwitch" yaml:"imciSwitch"`
	// Property plannedEndTime: The latest time at which a new node task can be added to start executing a timed (that is, within the target time period).
	//
	// The format is YYYY-MM-DDThh:mm:ssZ (UTC).
	PlannedEndTime interface{} `field:"optional" json:"plannedEndTime" yaml:"plannedEndTime"`
	// Property plannedStartTime: The earliest time at which a new node task can be added to start executing a timed (that is, within the target time period).
	//
	// The format is YYYY-MM-DDThh:mm:ssZ (UTC).
	PlannedStartTime interface{} `field:"optional" json:"plannedStartTime" yaml:"plannedStartTime"`
	// Property resourceGroupId: Resource group id.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `DBNodes`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbnodes

type Database

type Database interface {
	alicloudroscdkcore.Resource
	IDatabase
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DatabaseProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

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

func NewDatabase

func NewDatabase(scope alicloudroscdkcore.Construct, id *string, props *DatabaseProps, enableResourcePropertyConstraint *bool) Database

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DatabaseProps

type DatabaseProps struct {
	// Property characterSetName: The character set of the database.
	//
	// For more information, see Character sets.
	CharacterSetName interface{} `field:"required" json:"characterSetName" yaml:"characterSetName"`
	// Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a database is to be created.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property dbName: The name of the database to be created.
	//
	// The name must comply with the following rules:
	// It must start with a lowercase letter and consist of lowercase letters, digits, hyphens
	// (-), and underscores (_).
	// It must end with a letter or a digit. It can be up to 64 characters in length.
	DbName interface{} `field:"required" json:"dbName" yaml:"dbName"`
	// Property accountName: The name of the database account to be used.
	AccountName interface{} `field:"optional" json:"accountName" yaml:"accountName"`
	// Property accountPrivilege: The permissions of the database account on the database.
	//
	// Valid values:
	// ReadWrite: has read and write permissions on the database.
	// ReadOnly: has the read-only permission on the database.
	// DMLOnly: runs only data manipulation language (DML) statements.
	// DDLOnly: runs only data definition language (DDL) statements.
	// ReadIndex: has read and index permissions on the database.
	// Default value: ReadWrite.
	AccountPrivilege interface{} `field:"optional" json:"accountPrivilege" yaml:"accountPrivilege"`
	// Property collate: A locale setting that specifies the collation for newly created databases.
	//
	// The locale must be compatible with the character set set by the CharacterSetName parameter.When the cluster is PolarDB PostgreSQL (compatible with Oracle) or PolarDB PostgreSQL, this parameter is required;
	// when the cluster is PolarDB MySQL, this parameter is not supported.
	Collate interface{} `field:"optional" json:"collate" yaml:"collate"`
	// Property ctype: A locale setting that specifies the character classification of the database.
	//
	// The locale must be compatible with the character set set by the CharacterSetName parameter.
	// It is consistent with the incoming information of Collate.
	// When the cluster is PolarDB PostgreSQL (compatible with Oracle) or PolarDB PostgreSQL, this parameter is required;
	//   when the cluster is PolarDB MySQL, this parameter is optional.
	Ctype interface{} `field:"optional" json:"ctype" yaml:"ctype"`
	// Property dbDescription: The description of the database.
	//
	// Valid values:
	// It cannot start with http:\/\/ or https:\/\/.
	// It must be 2 to 256 characters in length.
	DbDescription interface{} `field:"optional" json:"dbDescription" yaml:"dbDescription"`
}

Properties for defining a `Database`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-database

type GlobalDatabaseNetwork

type GlobalDatabaseNetwork interface {
	alicloudroscdkcore.Resource
	IGlobalDatabaseNetwork
	// Attribute Connections: The information about the connection to the cluster.
	AttrConnections() interface{}
	// Attribute CreateTime: The time at which the GDN was created.
	AttrCreateTime() interface{}
	// Attribute DbClusters: The clusters that are included in the GDN.
	AttrDbClusters() interface{}
	// Attribute DbType: The type of the database engine.
	AttrDbType() interface{}
	// Attribute DbVersion: The version of the database engine.
	AttrDbVersion() interface{}
	// Attribute GdnDescription: The description of the GDN.
	AttrGdnDescription() interface{}
	// Attribute GdnId: The ID of the GDN.
	AttrGdnId() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *GlobalDatabaseNetworkProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::GlobalDatabaseNetwork`, which is used to create a global database network (GDN).

func NewGlobalDatabaseNetwork

func NewGlobalDatabaseNetwork(scope alicloudroscdkcore.Construct, id *string, props *GlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool) GlobalDatabaseNetwork

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type GlobalDatabaseNetworkProps

type GlobalDatabaseNetworkProps struct {
	// Property dbClusterId: The ID of the primary cluster.
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	// Property gdnDescription: The description of the GDN.
	GdnDescription interface{} `field:"optional" json:"gdnDescription" yaml:"gdnDescription"`
	// Property resourceGroupId: The ID of the resource group.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `GlobalDatabaseNetwork`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-globaldatabasenetwork

type IAITask added in v1.6.0

type IAITask interface {
	alicloudroscdkcore.IResource
	// Attribute DBClusterId: The ID of the DB cluster.
	AttrDbClusterId() interface{}
	Props() *AITaskProps
}

Represents a `AITask`.

type IAccount added in v1.6.0

type IAccount interface {
	alicloudroscdkcore.IResource
	Props() *AccountProps
}

Represents a `Account`.

type IAccountPrivilege added in v1.6.0

type IAccountPrivilege interface {
	alicloudroscdkcore.IResource
	Props() *AccountPrivilegeProps
}

Represents a `AccountPrivilege`.

type IBackup added in v1.6.0

type IBackup interface {
	alicloudroscdkcore.IResource
	// Attribute BackupJobId: The ID of the backup set.
	AttrBackupJobId() interface{}
	// Attribute DBClusterId: The ID of the cluster.
	AttrDbClusterId() interface{}
	Props() *BackupProps
}

Represents a `Backup`.

type IDBCluster added in v1.6.0

type IDBCluster interface {
	alicloudroscdkcore.IResource
	// Attribute ClusterConnectionString: The cluster connection string of the db cluster.
	AttrClusterConnectionString() interface{}
	// Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.
	AttrClusterEndpointId() interface{}
	// Attribute ColdStorageInstanceId: The ID of the cold storage instance.
	AttrColdStorageInstanceId() interface{}
	// Attribute CustomConnectionStrings: The custom connection strings of the db cluster.
	AttrCustomConnectionStrings() interface{}
	// Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.
	AttrCustomEndpointIds() interface{}
	// Attribute DBClusterDescription: The description of the db cluster.
	AttrDbClusterDescription() interface{}
	// Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.
	AttrDbClusterId() interface{}
	// Attribute DBNodeIds: The ID list of cluster nodes.
	AttrDbNodeIds() interface{}
	// Attribute OrderId: The Order ID.
	AttrOrderId() interface{}
	// Attribute PrimaryConnectionString: The primary connection string of the db cluster.
	AttrPrimaryConnectionString() interface{}
	// Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.
	AttrPrimaryConnectionStrings() interface{}
	// Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.
	AttrPrimaryEndpointId() interface{}
	// Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.
	AttrPrimaryEndpointIds() interface{}
	Props() *DBClusterProps
}

Represents a `DBCluster`.

type IDBClusterAccessWhiteList added in v1.6.0

type IDBClusterAccessWhiteList interface {
	alicloudroscdkcore.IResource
	// Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster whose IP address whitelist is to be modified.
	AttrDbClusterId() interface{}
	Props() *DBClusterAccessWhiteListProps
}

Represents a `DBClusterAccessWhiteList`.

type IDBClusterEndpoint added in v1.6.0

type IDBClusterEndpoint interface {
	alicloudroscdkcore.IResource
	// Attribute Addresses: The address items of the db cluster endpoint.
	AttrAddresses() interface{}
	// Attribute ConnectionString: The first connection string of the db cluster endpoint.
	AttrConnectionString() interface{}
	// Attribute DBEndpointId: DB cluster endpoint ID.
	//
	// E.g. pe-xxxxxxxx.
	AttrDbEndpointId() interface{}
	Props() *DBClusterEndpointProps
}

Represents a `DBClusterEndpoint`.

type IDBClusterEndpointAddress added in v1.6.0

type IDBClusterEndpointAddress interface {
	alicloudroscdkcore.IResource
	// Attribute Address: The details of the endpoint address.
	AttrAddress() interface{}
	// Attribute ConnectionString: The connection string of the endpoint address.
	AttrConnectionString() interface{}
	Props() *DBClusterEndpointAddressProps
}

Represents a `DBClusterEndpointAddress`.

type IDBNodes added in v1.6.0

type IDBNodes interface {
	alicloudroscdkcore.IResource
	// Attribute DBNodeIds: The ID list of added cluster nodes.
	AttrDbNodeIds() interface{}
	// Attribute OrderIds: The order ID list of added cluster nodes.
	AttrOrderIds() interface{}
	Props() *DBNodesProps
}

Represents a `DBNodes`.

type IDatabase added in v1.6.0

type IDatabase interface {
	alicloudroscdkcore.IResource
	Props() *DatabaseProps
}

Represents a `Database`.

type IGlobalDatabaseNetwork added in v1.6.0

type IGlobalDatabaseNetwork interface {
	alicloudroscdkcore.IResource
	// Attribute Connections: The information about the connection to the cluster.
	AttrConnections() interface{}
	// Attribute CreateTime: The time at which the GDN was created.
	AttrCreateTime() interface{}
	// Attribute DbClusters: The clusters that are included in the GDN.
	AttrDbClusters() interface{}
	// Attribute DbType: The type of the database engine.
	AttrDbType() interface{}
	// Attribute DbVersion: The version of the database engine.
	AttrDbVersion() interface{}
	// Attribute GdnDescription: The description of the GDN.
	AttrGdnDescription() interface{}
	// Attribute GdnId: The ID of the GDN.
	AttrGdnId() interface{}
	Props() *GlobalDatabaseNetworkProps
}

Represents a `GlobalDatabaseNetwork`.

type IParameterGroup added in v1.6.0

type IParameterGroup interface {
	alicloudroscdkcore.IResource
	// Attribute CreateTime: The time when the parameter template was created.
	AttrCreateTime() interface{}
	// Attribute DbType: The type of the database engine.
	AttrDbType() interface{}
	// Attribute DbVersion: The version of the database engine.
	AttrDbVersion() interface{}
	// Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
	AttrForceRestart() interface{}
	// Attribute ParameterCounts: The number of parameters in the parameter template.
	AttrParameterCounts() interface{}
	// Attribute ParameterGroupDesc: The description of the parameter template.
	AttrParameterGroupDesc() interface{}
	// Attribute ParameterGroupId: The ID of the parameter group.
	AttrParameterGroupId() interface{}
	// Attribute ParameterGroupName: The name of the parameter template.
	AttrParameterGroupName() interface{}
	// Attribute ParameterGroupType: The type of the parameter template.
	AttrParameterGroupType() interface{}
	// Attribute Parameters: The list of the parameters.
	AttrParameters() interface{}
	Props() *ParameterGroupProps
}

Represents a `ParameterGroup`.

type ParameterGroup

type ParameterGroup interface {
	alicloudroscdkcore.Resource
	IParameterGroup
	// Attribute CreateTime: The time when the parameter template was created.
	AttrCreateTime() interface{}
	// Attribute DbType: The type of the database engine.
	AttrDbType() interface{}
	// Attribute DbVersion: The version of the database engine.
	AttrDbVersion() interface{}
	// Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
	AttrForceRestart() interface{}
	// Attribute ParameterCounts: The number of parameters in the parameter template.
	AttrParameterCounts() interface{}
	// Attribute ParameterGroupDesc: The description of the parameter template.
	AttrParameterGroupDesc() interface{}
	// Attribute ParameterGroupId: The ID of the parameter group.
	AttrParameterGroupId() interface{}
	// Attribute ParameterGroupName: The name of the parameter template.
	AttrParameterGroupName() interface{}
	// Attribute ParameterGroupType: The type of the parameter template.
	AttrParameterGroupType() interface{}
	// Attribute Parameters: The list of the parameters.
	AttrParameters() interface{}
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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.
	Env() *alicloudroscdkcore.ResourceEnvironment
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *ParameterGroupProps
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDependency() *[]*string
	FetchResourceDesc() *string
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::POLARDB::ParameterGroup`, which is used to create a parameter template of PolarDB.

func NewParameterGroup

func NewParameterGroup(scope alicloudroscdkcore.Construct, id *string, props *ParameterGroupProps, enableResourcePropertyConstraint *bool) ParameterGroup

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type ParameterGroupProps

type ParameterGroupProps struct {
	// Property dbType: The type of the database engine.
	DbType interface{} `field:"required" json:"dbType" yaml:"dbType"`
	// Property dbVersion: The version of the database engine.
	DbVersion interface{} `field:"required" json:"dbVersion" yaml:"dbVersion"`
	// Property parameterGroupName: The name of the parameter template.
	ParameterGroupName interface{} `field:"required" json:"parameterGroupName" yaml:"parameterGroupName"`
	// Property parameters: The list of the parameters.
	Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"`
	// Property parameterGroupDesc: The description of the parameter template.
	ParameterGroupDesc interface{} `field:"optional" json:"parameterGroupDesc" yaml:"parameterGroupDesc"`
	// Property resourceGroupId: The ID of the resource group.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `ParameterGroup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-parametergroup

type RosAITask

type RosAITask interface {
	alicloudroscdkcore.RosResource
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	NodeType() interface{}
	SetNodeType(val interface{})
	Password() interface{}
	SetPassword(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	Username() interface{}
	SetUsername(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::AITask`, which is used to enable the PolarDB for AI feature.

func NewRosAITask

func NewRosAITask(scope alicloudroscdkcore.Construct, id *string, props *RosAITaskProps, enableResourcePropertyConstraint *bool) RosAITask

type RosAITaskProps

type RosAITaskProps struct {
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	Password    interface{} `field:"required" json:"password" yaml:"password"`
	Username    interface{} `field:"required" json:"username" yaml:"username"`
	NodeType    interface{} `field:"optional" json:"nodeType" yaml:"nodeType"`
}

Properties for defining a `RosAITask`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-aitask

type RosAccount

type RosAccount interface {
	alicloudroscdkcore.RosResource
	AccountDescription() interface{}
	SetAccountDescription(val interface{})
	AccountName() interface{}
	SetAccountName(val interface{})
	AccountPassword() interface{}
	SetAccountPassword(val interface{})
	AccountPrivilege() interface{}
	SetAccountPrivilege(val interface{})
	AccountType() interface{}
	SetAccountType(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbName() interface{}
	SetDbName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	PrivForAllDb() interface{}
	SetPrivForAllDb(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::Account`, which is used to create a database account for a specified PolarDB cluster.

func NewRosAccount

func NewRosAccount(scope alicloudroscdkcore.Construct, id *string, props *RosAccountProps, enableResourcePropertyConstraint *bool) RosAccount

type RosAccountPrivilege

type RosAccountPrivilege interface {
	alicloudroscdkcore.RosResource
	AccountName() interface{}
	SetAccountName(val interface{})
	AccountPrivilege() interface{}
	SetAccountPrivilege(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbName() interface{}
	SetDbName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::AccountPrivilege`, which is used to grant access permissions on one or more databases in a specified ApsaraDB for POLARDB cluster to a standard account.

func NewRosAccountPrivilege

func NewRosAccountPrivilege(scope alicloudroscdkcore.Construct, id *string, props *RosAccountPrivilegeProps, enableResourcePropertyConstraint *bool) RosAccountPrivilege

type RosAccountPrivilegeProps

type RosAccountPrivilegeProps struct {
	AccountName      interface{} `field:"required" json:"accountName" yaml:"accountName"`
	AccountPrivilege interface{} `field:"required" json:"accountPrivilege" yaml:"accountPrivilege"`
	DbClusterId      interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	DbName           interface{} `field:"required" json:"dbName" yaml:"dbName"`
}

Properties for defining a `RosAccountPrivilege`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-accountprivilege

type RosAccountProps

type RosAccountProps struct {
	AccountName        interface{} `field:"required" json:"accountName" yaml:"accountName"`
	AccountPassword    interface{} `field:"required" json:"accountPassword" yaml:"accountPassword"`
	DbClusterId        interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	AccountDescription interface{} `field:"optional" json:"accountDescription" yaml:"accountDescription"`
	AccountPrivilege   interface{} `field:"optional" json:"accountPrivilege" yaml:"accountPrivilege"`
	AccountType        interface{} `field:"optional" json:"accountType" yaml:"accountType"`
	DbName             interface{} `field:"optional" json:"dbName" yaml:"dbName"`
	PrivForAllDb       interface{} `field:"optional" json:"privForAllDb" yaml:"privForAllDb"`
}

Properties for defining a `RosAccount`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-account

type RosBackup added in v1.3.0

type RosBackup interface {
	alicloudroscdkcore.RosResource
	AttrBackupJobId() alicloudroscdkcore.IResolvable
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::Backup`.

func NewRosBackup added in v1.3.0

func NewRosBackup(scope alicloudroscdkcore.Construct, id *string, props *RosBackupProps, enableResourcePropertyConstraint *bool) RosBackup

type RosBackupProps added in v1.3.0

type RosBackupProps struct {
	DbClusterId interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
}

Properties for defining a `RosBackup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-backup

type RosDBCluster

type RosDBCluster interface {
	alicloudroscdkcore.RosResource
	AllowShutDown() interface{}
	SetAllowShutDown(val interface{})
	Architecture() interface{}
	SetArchitecture(val interface{})
	AttrClusterConnectionString() alicloudroscdkcore.IResolvable
	AttrClusterEndpointId() alicloudroscdkcore.IResolvable
	AttrColdStorageInstanceId() alicloudroscdkcore.IResolvable
	AttrCustomConnectionStrings() alicloudroscdkcore.IResolvable
	AttrCustomEndpointIds() alicloudroscdkcore.IResolvable
	AttrDbClusterDescription() alicloudroscdkcore.IResolvable
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	AttrDbNodeIds() alicloudroscdkcore.IResolvable
	AttrOrderId() alicloudroscdkcore.IResolvable
	AttrPrimaryConnectionString() alicloudroscdkcore.IResolvable
	AttrPrimaryConnectionStrings() alicloudroscdkcore.IResolvable
	AttrPrimaryEndpointId() alicloudroscdkcore.IResolvable
	AttrPrimaryEndpointIds() alicloudroscdkcore.IResolvable
	AutoRenewPeriod() interface{}
	SetAutoRenewPeriod(val interface{})
	BackupRetentionPolicyOnClusterDeletion() interface{}
	SetBackupRetentionPolicyOnClusterDeletion(val interface{})
	CloneDataPoint() interface{}
	SetCloneDataPoint(val interface{})
	ClusterNetworkType() interface{}
	SetClusterNetworkType(val interface{})
	ColdStorageOption() interface{}
	SetColdStorageOption(val interface{})
	CreationCategory() interface{}
	SetCreationCategory(val interface{})
	CreationOption() interface{}
	SetCreationOption(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterDescription() interface{}
	SetDbClusterDescription(val interface{})
	DbClusterParameters() interface{}
	SetDbClusterParameters(val interface{})
	DbMinorVersion() interface{}
	SetDbMinorVersion(val interface{})
	DbNodeClass() interface{}
	SetDbNodeClass(val interface{})
	DbNodeNum() interface{}
	SetDbNodeNum(val interface{})
	DbType() interface{}
	SetDbType(val interface{})
	DbVersion() interface{}
	SetDbVersion(val interface{})
	DefaultTimeZone() interface{}
	SetDefaultTimeZone(val interface{})
	DeletionProtection() interface{}
	SetDeletionProtection(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	GdnId() interface{}
	SetGdnId(val interface{})
	HotStandbyCluster() interface{}
	SetHotStandbyCluster(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	LoosePolarLogBin() interface{}
	SetLoosePolarLogBin(val interface{})
	LooseXEngine() interface{}
	SetLooseXEngine(val interface{})
	LooseXEngineUseMemoryPct() interface{}
	SetLooseXEngineUseMemoryPct(val interface{})
	LowerCaseTableNames() interface{}
	SetLowerCaseTableNames(val interface{})
	MaintainTime() interface{}
	SetMaintainTime(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	ParameterGroupId() interface{}
	SetParameterGroupId(val interface{})
	PayType() interface{}
	SetPayType(val interface{})
	Period() interface{}
	SetPeriod(val interface{})
	PeriodUnit() interface{}
	SetPeriodUnit(val interface{})
	ProvisionedIops() interface{}
	SetProvisionedIops(val interface{})
	ProxyClass() interface{}
	SetProxyClass(val interface{})
	ProxyType() interface{}
	SetProxyType(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	RenewalStatus() interface{}
	SetRenewalStatus(val interface{})
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	RestartMasterNode() interface{}
	SetRestartMasterNode(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	ScaleMax() interface{}
	SetScaleMax(val interface{})
	ScaleMin() interface{}
	SetScaleMin(val interface{})
	ScaleRoNumMax() interface{}
	SetScaleRoNumMax(val interface{})
	ScaleRoNumMin() interface{}
	SetScaleRoNumMin(val interface{})
	SecurityGroupIds() interface{}
	SetSecurityGroupIds(val interface{})
	SecurityIpList() interface{}
	SetSecurityIpList(val interface{})
	ServerlessType() interface{}
	SetServerlessType(val interface{})
	SourceResourceId() interface{}
	SetSourceResourceId(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	StandbyAz() interface{}
	SetStandbyAz(val interface{})
	StorageAutoScale() interface{}
	SetStorageAutoScale(val interface{})
	StoragePayType() interface{}
	SetStoragePayType(val interface{})
	StorageSpace() interface{}
	SetStorageSpace(val interface{})
	StorageType() interface{}
	SetStorageType(val interface{})
	StorageUpperBound() interface{}
	SetStorageUpperBound(val interface{})
	StrictConsistency() interface{}
	SetStrictConsistency(val interface{})
	Tags() *[]*RosDBCluster_TagsProperty
	SetTags(val *[]*RosDBCluster_TagsProperty)
	TdeStatus() interface{}
	SetTdeStatus(val interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VpcId() interface{}
	SetVpcId(val interface{})
	VSwitchId() interface{}
	SetVSwitchId(val interface{})
	ZoneId() interface{}
	SetZoneId(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::DBCluster`, which is used to create a PolarDB cluster.

func NewRosDBCluster

func NewRosDBCluster(scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterProps, enableResourcePropertyConstraint *bool) RosDBCluster

type RosDBClusterAccessWhiteList

type RosDBClusterAccessWhiteList interface {
	alicloudroscdkcore.RosResource
	AttrDbClusterId() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbClusterIpArrayName() interface{}
	SetDbClusterIpArrayName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	SecurityIps() interface{}
	SetSecurityIps(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::DBClusterAccessWhiteList`, which is used to modify the list of IP addresses that are allowed to access an ApsaraDB for POLARDB cluster.

func NewRosDBClusterAccessWhiteList

func NewRosDBClusterAccessWhiteList(scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterAccessWhiteListProps, enableResourcePropertyConstraint *bool) RosDBClusterAccessWhiteList

type RosDBClusterAccessWhiteListProps

type RosDBClusterAccessWhiteListProps struct {
	DbClusterId          interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	SecurityIps          interface{} `field:"required" json:"securityIps" yaml:"securityIps"`
	DbClusterIpArrayName interface{} `field:"optional" json:"dbClusterIpArrayName" yaml:"dbClusterIpArrayName"`
}

Properties for defining a `RosDBClusterAccessWhiteList`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusteraccesswhitelist

type RosDBClusterEndpoint

type RosDBClusterEndpoint interface {
	alicloudroscdkcore.RosResource
	AttrAddresses() alicloudroscdkcore.IResolvable
	AttrConnectionString() alicloudroscdkcore.IResolvable
	AttrDbEndpointId() alicloudroscdkcore.IResolvable
	AutoAddNewNodes() interface{}
	SetAutoAddNewNodes(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	EndpointConfig() interface{}
	SetEndpointConfig(val interface{})
	EndpointType() interface{}
	SetEndpointType(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	Nodes() interface{}
	SetNodes(val interface{})
	ReadWriteMode() interface{}
	SetReadWriteMode(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::DBClusterEndpoint`, which is used to create a custom endpoint for a PolarDB cluster.

func NewRosDBClusterEndpoint

func NewRosDBClusterEndpoint(scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterEndpointProps, enableResourcePropertyConstraint *bool) RosDBClusterEndpoint

type RosDBClusterEndpointAddress

type RosDBClusterEndpointAddress interface {
	alicloudroscdkcore.RosResource
	AttrAddress() alicloudroscdkcore.IResolvable
	AttrConnectionString() alicloudroscdkcore.IResolvable
	ConnectionStringPrefix() interface{}
	SetConnectionStringPrefix(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbEndpointId() interface{}
	SetDbEndpointId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	NetType() interface{}
	SetNetType(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::DBClusterEndpointAddress`, which is used to create a public endpoint for an Apsara PolarDB cluster.

The public endpoint can be a primary endpoint, the default cluster endpoint, or a custom cluster endpoint.

func NewRosDBClusterEndpointAddress

func NewRosDBClusterEndpointAddress(scope alicloudroscdkcore.Construct, id *string, props *RosDBClusterEndpointAddressProps, enableResourcePropertyConstraint *bool) RosDBClusterEndpointAddress

type RosDBClusterEndpointAddressProps

type RosDBClusterEndpointAddressProps struct {
	DbClusterId            interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	DbEndpointId           interface{} `field:"required" json:"dbEndpointId" yaml:"dbEndpointId"`
	ConnectionStringPrefix interface{} `field:"optional" json:"connectionStringPrefix" yaml:"connectionStringPrefix"`
	NetType                interface{} `field:"optional" json:"netType" yaml:"netType"`
}

Properties for defining a `RosDBClusterEndpointAddress`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusterendpointaddress

type RosDBClusterEndpointProps

type RosDBClusterEndpointProps struct {
	DbClusterId     interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	AutoAddNewNodes interface{} `field:"optional" json:"autoAddNewNodes" yaml:"autoAddNewNodes"`
	EndpointConfig  interface{} `field:"optional" json:"endpointConfig" yaml:"endpointConfig"`
	EndpointType    interface{} `field:"optional" json:"endpointType" yaml:"endpointType"`
	Nodes           interface{} `field:"optional" json:"nodes" yaml:"nodes"`
	ReadWriteMode   interface{} `field:"optional" json:"readWriteMode" yaml:"readWriteMode"`
}

Properties for defining a `RosDBClusterEndpoint`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbclusterendpoint

type RosDBClusterEndpoint_EndpointConfigProperty

type RosDBClusterEndpoint_EndpointConfigProperty struct {
	ConnectionPersist      interface{} `field:"optional" json:"connectionPersist" yaml:"connectionPersist"`
	ConsistLevel           interface{} `field:"optional" json:"consistLevel" yaml:"consistLevel"`
	ConsistTimeout         interface{} `field:"optional" json:"consistTimeout" yaml:"consistTimeout"`
	ConsistTimeoutAction   interface{} `field:"optional" json:"consistTimeoutAction" yaml:"consistTimeoutAction"`
	DistributedTransaction interface{} `field:"optional" json:"distributedTransaction" yaml:"distributedTransaction"`
	EnableHtapImci         interface{} `field:"optional" json:"enableHtapImci" yaml:"enableHtapImci"`
	EnableOverloadThrottle interface{} `field:"optional" json:"enableOverloadThrottle" yaml:"enableOverloadThrottle"`
	LoadBalancePolicy      interface{} `field:"optional" json:"loadBalancePolicy" yaml:"loadBalancePolicy"`
	MasterAcceptReads      interface{} `field:"optional" json:"masterAcceptReads" yaml:"masterAcceptReads"`
	MaxParallelDegree      interface{} `field:"optional" json:"maxParallelDegree" yaml:"maxParallelDegree"`
}

type RosDBClusterProps

type RosDBClusterProps struct {
	DbNodeClass                            interface{}                   `field:"required" json:"dbNodeClass" yaml:"dbNodeClass"`
	DbType                                 interface{}                   `field:"required" json:"dbType" yaml:"dbType"`
	DbVersion                              interface{}                   `field:"required" json:"dbVersion" yaml:"dbVersion"`
	PayType                                interface{}                   `field:"required" json:"payType" yaml:"payType"`
	AllowShutDown                          interface{}                   `field:"optional" json:"allowShutDown" yaml:"allowShutDown"`
	Architecture                           interface{}                   `field:"optional" json:"architecture" yaml:"architecture"`
	AutoRenewPeriod                        interface{}                   `field:"optional" json:"autoRenewPeriod" yaml:"autoRenewPeriod"`
	BackupRetentionPolicyOnClusterDeletion interface{}                   `field:"optional" json:"backupRetentionPolicyOnClusterDeletion" yaml:"backupRetentionPolicyOnClusterDeletion"`
	CloneDataPoint                         interface{}                   `field:"optional" json:"cloneDataPoint" yaml:"cloneDataPoint"`
	ClusterNetworkType                     interface{}                   `field:"optional" json:"clusterNetworkType" yaml:"clusterNetworkType"`
	ColdStorageOption                      interface{}                   `field:"optional" json:"coldStorageOption" yaml:"coldStorageOption"`
	CreationCategory                       interface{}                   `field:"optional" json:"creationCategory" yaml:"creationCategory"`
	CreationOption                         interface{}                   `field:"optional" json:"creationOption" yaml:"creationOption"`
	DbClusterDescription                   interface{}                   `field:"optional" json:"dbClusterDescription" yaml:"dbClusterDescription"`
	DbClusterParameters                    interface{}                   `field:"optional" json:"dbClusterParameters" yaml:"dbClusterParameters"`
	DbMinorVersion                         interface{}                   `field:"optional" json:"dbMinorVersion" yaml:"dbMinorVersion"`
	DbNodeNum                              interface{}                   `field:"optional" json:"dbNodeNum" yaml:"dbNodeNum"`
	DefaultTimeZone                        interface{}                   `field:"optional" json:"defaultTimeZone" yaml:"defaultTimeZone"`
	DeletionProtection                     interface{}                   `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
	GdnId                                  interface{}                   `field:"optional" json:"gdnId" yaml:"gdnId"`
	HotStandbyCluster                      interface{}                   `field:"optional" json:"hotStandbyCluster" yaml:"hotStandbyCluster"`
	LoosePolarLogBin                       interface{}                   `field:"optional" json:"loosePolarLogBin" yaml:"loosePolarLogBin"`
	LooseXEngine                           interface{}                   `field:"optional" json:"looseXEngine" yaml:"looseXEngine"`
	LooseXEngineUseMemoryPct               interface{}                   `field:"optional" json:"looseXEngineUseMemoryPct" yaml:"looseXEngineUseMemoryPct"`
	LowerCaseTableNames                    interface{}                   `field:"optional" json:"lowerCaseTableNames" yaml:"lowerCaseTableNames"`
	MaintainTime                           interface{}                   `field:"optional" json:"maintainTime" yaml:"maintainTime"`
	ParameterGroupId                       interface{}                   `field:"optional" json:"parameterGroupId" yaml:"parameterGroupId"`
	Period                                 interface{}                   `field:"optional" json:"period" yaml:"period"`
	PeriodUnit                             interface{}                   `field:"optional" json:"periodUnit" yaml:"periodUnit"`
	ProvisionedIops                        interface{}                   `field:"optional" json:"provisionedIops" yaml:"provisionedIops"`
	ProxyClass                             interface{}                   `field:"optional" json:"proxyClass" yaml:"proxyClass"`
	ProxyType                              interface{}                   `field:"optional" json:"proxyType" yaml:"proxyType"`
	RenewalStatus                          interface{}                   `field:"optional" json:"renewalStatus" yaml:"renewalStatus"`
	ResourceGroupId                        interface{}                   `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	RestartMasterNode                      interface{}                   `field:"optional" json:"restartMasterNode" yaml:"restartMasterNode"`
	ScaleMax                               interface{}                   `field:"optional" json:"scaleMax" yaml:"scaleMax"`
	ScaleMin                               interface{}                   `field:"optional" json:"scaleMin" yaml:"scaleMin"`
	ScaleRoNumMax                          interface{}                   `field:"optional" json:"scaleRoNumMax" yaml:"scaleRoNumMax"`
	ScaleRoNumMin                          interface{}                   `field:"optional" json:"scaleRoNumMin" yaml:"scaleRoNumMin"`
	SecurityGroupIds                       interface{}                   `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
	SecurityIpList                         interface{}                   `field:"optional" json:"securityIpList" yaml:"securityIpList"`
	ServerlessType                         interface{}                   `field:"optional" json:"serverlessType" yaml:"serverlessType"`
	SourceResourceId                       interface{}                   `field:"optional" json:"sourceResourceId" yaml:"sourceResourceId"`
	StandbyAz                              interface{}                   `field:"optional" json:"standbyAz" yaml:"standbyAz"`
	StorageAutoScale                       interface{}                   `field:"optional" json:"storageAutoScale" yaml:"storageAutoScale"`
	StoragePayType                         interface{}                   `field:"optional" json:"storagePayType" yaml:"storagePayType"`
	StorageSpace                           interface{}                   `field:"optional" json:"storageSpace" yaml:"storageSpace"`
	StorageType                            interface{}                   `field:"optional" json:"storageType" yaml:"storageType"`
	StorageUpperBound                      interface{}                   `field:"optional" json:"storageUpperBound" yaml:"storageUpperBound"`
	StrictConsistency                      interface{}                   `field:"optional" json:"strictConsistency" yaml:"strictConsistency"`
	Tags                                   *[]*RosDBCluster_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	TdeStatus                              interface{}                   `field:"optional" json:"tdeStatus" yaml:"tdeStatus"`
	VpcId                                  interface{}                   `field:"optional" json:"vpcId" yaml:"vpcId"`
	VSwitchId                              interface{}                   `field:"optional" json:"vSwitchId" yaml:"vSwitchId"`
	ZoneId                                 interface{}                   `field:"optional" json:"zoneId" yaml:"zoneId"`
}

Properties for defining a `RosDBCluster`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbcluster

type RosDBCluster_ColdStorageOptionProperty

type RosDBCluster_ColdStorageOptionProperty struct {
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	Enable      interface{} `field:"optional" json:"enable" yaml:"enable"`
}

type RosDBCluster_DBClusterParametersProperty

type RosDBCluster_DBClusterParametersProperty struct {
	EffectiveTime interface{} `field:"optional" json:"effectiveTime" yaml:"effectiveTime"`
	Parameters    interface{} `field:"optional" json:"parameters" yaml:"parameters"`
}

type RosDBCluster_TagsProperty

type RosDBCluster_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type RosDBNodes

type RosDBNodes interface {
	alicloudroscdkcore.RosResource
	Amount() interface{}
	SetAmount(val interface{})
	AttrDbNodeIds() alicloudroscdkcore.IResolvable
	AttrOrderIds() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbNodeType() interface{}
	SetDbNodeType(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	EndpointBindList() interface{}
	SetEndpointBindList(val interface{})
	ImciSwitch() interface{}
	SetImciSwitch(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	PlannedEndTime() interface{}
	SetPlannedEndTime(val interface{})
	PlannedStartTime() interface{}
	SetPlannedStartTime(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::DBNodes`, which is used to add nodes to a PolarDB cluster.

func NewRosDBNodes

func NewRosDBNodes(scope alicloudroscdkcore.Construct, id *string, props *RosDBNodesProps, enableResourcePropertyConstraint *bool) RosDBNodes

type RosDBNodesProps

type RosDBNodesProps struct {
	Amount           interface{} `field:"required" json:"amount" yaml:"amount"`
	DbClusterId      interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	DbNodeType       interface{} `field:"optional" json:"dbNodeType" yaml:"dbNodeType"`
	EndpointBindList interface{} `field:"optional" json:"endpointBindList" yaml:"endpointBindList"`
	ImciSwitch       interface{} `field:"optional" json:"imciSwitch" yaml:"imciSwitch"`
	PlannedEndTime   interface{} `field:"optional" json:"plannedEndTime" yaml:"plannedEndTime"`
	PlannedStartTime interface{} `field:"optional" json:"plannedStartTime" yaml:"plannedStartTime"`
	ResourceGroupId  interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `RosDBNodes`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-dbnodes

type RosDatabase

type RosDatabase interface {
	alicloudroscdkcore.RosResource
	AccountName() interface{}
	SetAccountName(val interface{})
	AccountPrivilege() interface{}
	SetAccountPrivilege(val interface{})
	CharacterSetName() interface{}
	SetCharacterSetName(val interface{})
	Collate() interface{}
	SetCollate(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Ctype() interface{}
	SetCtype(val interface{})
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	DbDescription() interface{}
	SetDbDescription(val interface{})
	DbName() interface{}
	SetDbName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::Database`, which is used to create a database in a PolarDB cluster.

func NewRosDatabase

func NewRosDatabase(scope alicloudroscdkcore.Construct, id *string, props *RosDatabaseProps, enableResourcePropertyConstraint *bool) RosDatabase

type RosDatabaseProps

type RosDatabaseProps struct {
	CharacterSetName interface{} `field:"required" json:"characterSetName" yaml:"characterSetName"`
	DbClusterId      interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	DbName           interface{} `field:"required" json:"dbName" yaml:"dbName"`
	AccountName      interface{} `field:"optional" json:"accountName" yaml:"accountName"`
	AccountPrivilege interface{} `field:"optional" json:"accountPrivilege" yaml:"accountPrivilege"`
	Collate          interface{} `field:"optional" json:"collate" yaml:"collate"`
	Ctype            interface{} `field:"optional" json:"ctype" yaml:"ctype"`
	DbDescription    interface{} `field:"optional" json:"dbDescription" yaml:"dbDescription"`
}

Properties for defining a `RosDatabase`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-database

type RosGlobalDatabaseNetwork

type RosGlobalDatabaseNetwork interface {
	alicloudroscdkcore.RosResource
	AttrConnections() alicloudroscdkcore.IResolvable
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrDbClusters() alicloudroscdkcore.IResolvable
	AttrDbType() alicloudroscdkcore.IResolvable
	AttrDbVersion() alicloudroscdkcore.IResolvable
	AttrGdnDescription() alicloudroscdkcore.IResolvable
	AttrGdnId() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbClusterId() interface{}
	SetDbClusterId(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	GdnDescription() interface{}
	SetGdnDescription(val interface{})
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::GlobalDatabaseNetwork`, which is used to create a global database network (GDN).

func NewRosGlobalDatabaseNetwork

func NewRosGlobalDatabaseNetwork(scope alicloudroscdkcore.Construct, id *string, props *RosGlobalDatabaseNetworkProps, enableResourcePropertyConstraint *bool) RosGlobalDatabaseNetwork

type RosGlobalDatabaseNetworkProps

type RosGlobalDatabaseNetworkProps struct {
	DbClusterId     interface{} `field:"required" json:"dbClusterId" yaml:"dbClusterId"`
	GdnDescription  interface{} `field:"optional" json:"gdnDescription" yaml:"gdnDescription"`
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `RosGlobalDatabaseNetwork`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-globaldatabasenetwork

type RosParameterGroup

type RosParameterGroup interface {
	alicloudroscdkcore.RosResource
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrDbType() alicloudroscdkcore.IResolvable
	AttrDbVersion() alicloudroscdkcore.IResolvable
	AttrForceRestart() alicloudroscdkcore.IResolvable
	AttrParameterCounts() alicloudroscdkcore.IResolvable
	AttrParameterGroupDesc() alicloudroscdkcore.IResolvable
	AttrParameterGroupId() alicloudroscdkcore.IResolvable
	AttrParameterGroupName() alicloudroscdkcore.IResolvable
	AttrParameterGroupType() alicloudroscdkcore.IResolvable
	AttrParameters() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	DbType() interface{}
	SetDbType(val interface{})
	DbVersion() interface{}
	SetDbVersion(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// The logical ID for this stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	ParameterGroupDesc() interface{}
	SetParameterGroupDesc(val interface{})
	ParameterGroupName() interface{}
	SetParameterGroupName(val interface{})
	Parameters() interface{}
	SetParameters(val interface{})
	// Return a string that will be resolved to a RosTemplate `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// Adds an override to the synthesized ROS resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// For example,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	FetchCondition() alicloudroscdkcore.RosCondition
	FetchDesc() *string
	FetchRosDependency() *[]*string
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::POLARDB::ParameterGroup`, which is used to create a parameter template of PolarDB.

func NewRosParameterGroup

func NewRosParameterGroup(scope alicloudroscdkcore.Construct, id *string, props *RosParameterGroupProps, enableResourcePropertyConstraint *bool) RosParameterGroup

type RosParameterGroupProps

type RosParameterGroupProps struct {
	DbType             interface{} `field:"required" json:"dbType" yaml:"dbType"`
	DbVersion          interface{} `field:"required" json:"dbVersion" yaml:"dbVersion"`
	ParameterGroupName interface{} `field:"required" json:"parameterGroupName" yaml:"parameterGroupName"`
	Parameters         interface{} `field:"required" json:"parameters" yaml:"parameters"`
	ParameterGroupDesc interface{} `field:"optional" json:"parameterGroupDesc" yaml:"parameterGroupDesc"`
	ResourceGroupId    interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
}

Properties for defining a `RosParameterGroup`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-parametergroup

type RosParameterGroup_ParametersProperty

type RosParameterGroup_ParametersProperty struct {
	ParamName  interface{} `field:"required" json:"paramName" yaml:"paramName"`
	ParamValue interface{} `field:"required" json:"paramValue" yaml:"paramValue"`
}

Source Files

Directories

Path Synopsis
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL