ProxyTargetConfig

class aws_cdk.aws_rds.ProxyTargetConfig(*, engine_family, db_clusters=None, db_instances=None)

Bases: object

The result of binding a ProxyTarget to a DatabaseProxy.

Parameters

  • engine_family (str) – The engine family of the database instance or cluster this proxy connects with.

  • db_clusters (Optional[Sequence[IDatabaseCluster]]) – The database clusters to which this proxy connects. Either this or dbInstances will be set and the other undefined. Default: - undefined if dbInstances is set.

  • db_instances (Optional[Sequence[IDatabaseInstance]]) – The database instances to which this proxy connects. Either this or dbClusters will be set and the other undefined. Default: - undefined if dbClusters is set.

ExampleMetadata

fixture=_generated

Example:

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

# database_cluster: rds.DatabaseCluster
# database_instance: rds.DatabaseInstance

proxy_target_config = rds.ProxyTargetConfig(
    engine_family="engineFamily",

    # the properties below are optional
    db_clusters=[database_cluster],
    db_instances=[database_instance]
)

Attributes

db_clusters

The database clusters to which this proxy connects.

Either this or dbInstances will be set and the other undefined.

Default

  • undefined if dbInstances is set.

Return type

Optional[List[IDatabaseCluster]]

db_instances

The database instances to which this proxy connects.

Either this or dbClusters will be set and the other undefined.

Default

  • undefined if dbClusters is set.

Return type

Optional[List[IDatabaseInstance]]

engine_family

The engine family of the database instance or cluster this proxy connects with.

Return type

str