ParameterGroup

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

Initializers

import ros_cdk_polardb
ros_cdk_polardb.ParameterGroup(
  scope: Construct,
  id: str,
  db_type: typing.Union[str, IResolvable],
  db_version: typing.Union[str, IResolvable],
  parameter_group_name: typing.Union[str, IResolvable],
  parameters: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ParametersProperty]]],
  parameter_group_desc: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
db_type	typing.Union[str, ros_cdk_core.IResolvable]	Property dbType: The type of the database engine.
db_version	typing.Union[str, ros_cdk_core.IResolvable]	Property dbVersion: The version of the database engine.
parameter_group_name	typing.Union[str, ros_cdk_core.IResolvable]	Property parameterGroupName: The name of the parameter template.
parameters	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ParametersProperty]]]	Property parameters: The list of the parameters.
parameter_group_desc	typing.Union[str, ros_cdk_core.IResolvable]	Property parameterGroupDesc: The description of the parameter template.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

db_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbType: The type of the database engine.

---

db_version^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbVersion: The version of the database engine.

---

parameter_group_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property parameterGroupName: The name of the parameter template.

---

parameters^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ParametersProperty]]]

Property parameters: The list of the parameters.

---

parameter_group_desc^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property parameterGroupDesc: The description of the parameter template.

---

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_polardb
ros_cdk_polardb.ParameterGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the parameter template was created.
attr_db_type	ros_cdk_core.IResolvable	Attribute DbType: The type of the database engine.
attr_db_version	ros_cdk_core.IResolvable	Attribute DbVersion: The version of the database engine.
attr_force_restart	ros_cdk_core.IResolvable	Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.
attr_parameter_counts	ros_cdk_core.IResolvable	Attribute ParameterCounts: The number of parameters in the parameter template.
attr_parameter_group_desc	ros_cdk_core.IResolvable	Attribute ParameterGroupDesc: The description of the parameter template.
attr_parameter_group_id	ros_cdk_core.IResolvable	Attribute ParameterGroupId: The ID of the parameter group.
attr_parameter_group_name	ros_cdk_core.IResolvable	Attribute ParameterGroupName: The name of the parameter template.
attr_parameter_group_type	ros_cdk_core.IResolvable	Attribute ParameterGroupType: The type of the parameter template.
attr_parameters	ros_cdk_core.IResolvable	Attribute Parameters: The list of the parameters.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the parameter template was created.

---

attr_db_type^Required

attr_db_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DbType: The type of the database engine.

---

attr_db_version^Required

attr_db_version: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DbVersion: The version of the database engine.

---

attr_force_restart^Required

attr_force_restart: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ForceRestart: Indicates whether to restart the cluster when this parameter template is applied.

---

attr_parameter_counts^Required

attr_parameter_counts: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterCounts: The number of parameters in the parameter template.

---

attr_parameter_group_desc^Required

attr_parameter_group_desc: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterGroupDesc: The description of the parameter template.

---

attr_parameter_group_id^Required

attr_parameter_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterGroupId: The ID of the parameter group.

---

attr_parameter_group_name^Required

attr_parameter_group_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterGroupName: The name of the parameter template.

---

attr_parameter_group_type^Required

attr_parameter_group_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterGroupType: The type of the parameter template.

---

attr_parameters^Required

attr_parameters: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Parameters: The list of the parameters.

---