ClusterEngineConfig

class aws_cdk.aws_rds.ClusterEngineConfig(*, features=None, parameter_group=None, port=None)

Bases: object

The type returned from the IClusterEngine.bindToCluster method.

Parameters:
  • features (Union[ClusterEngineFeatures, Dict[str, Any], None]) – Features supported by the database engine. Default: - no features

  • parameter_group (Optional[IParameterGroup]) – The ParameterGroup to use for the cluster. Default: - no ParameterGroup will be used

  • port (Union[int, float, None]) – The port to use for this cluster, unless the customer specified the port directly. Default: - use the default port for clusters (3306)

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

# parameter_group: rds.ParameterGroup

cluster_engine_config = rds.ClusterEngineConfig(
    features=rds.ClusterEngineFeatures(
        s3_export="s3Export",
        s3_import="s3Import"
    ),
    parameter_group=parameter_group,
    port=123
)

Attributes

features

Features supported by the database engine.

Default:
  • no features

See:

https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html

parameter_group

The ParameterGroup to use for the cluster.

Default:
  • no ParameterGroup will be used

port

The port to use for this cluster, unless the customer specified the port directly.

Default:
  • use the default port for clusters (3306)