ProxyTarget

class aws_cdk.aws_rds.ProxyTarget(*args: Any, **kwargs)

Bases: object

Proxy target: Instance or Cluster.

A target group is a collection of databases that the proxy can connect to. Currently, you can specify only one RDS DB instance or Aurora DB cluster.

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc

instance = rds.DatabaseInstance(self, "Database",
    engine=rds.DatabaseInstanceEngine.postgres(
        version=rds.PostgresEngineVersion.VER_17_7
    ),
    vpc=vpc,
    iam_authentication=True
)

proxy = rds.DatabaseProxy(self, "Proxy",
    proxy_target=rds.ProxyTarget.from_instance(instance),
    vpc=vpc,
    default_auth_scheme=rds.DefaultAuthScheme.IAM_AUTH
)

# Grant IAM permissions for database connection
role = iam.Role(self, "DBRole", assumed_by=iam.AccountPrincipal(self.account))
proxy.grant_connect(role, "database-user")

Methods

bind(proxy)

Bind this target to the specified database proxy.

Parameters:

proxy (DatabaseProxy)

Return type:

ProxyTargetConfig

Static Methods

classmethod from_cluster(cluster)

From cluster.

Parameters:

cluster (IDatabaseCluster) – RDS database cluster.

Return type:

ProxyTarget

classmethod from_instance(instance)

From instance.

Parameters:

instance (IDatabaseInstance) – RDS database instance.

Return type:

ProxyTarget