Class ProxyTarget

Proxy target: Instance or Cluster.

Inheritance

object

ProxyTarget

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ProxyTarget : DeputyBase

Syntax (vb)

Public Class ProxyTarget Inherits DeputyBase

Remarks

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

Examples

Vpc vpc;

             var instance = new DatabaseInstance(this, "Database", new DatabaseInstanceProps {
                 Engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps {
                     Version = PostgresEngineVersion.VER_17_7
                 }),
                 Vpc = vpc,
                 IamAuthentication = true
             });

             var proxy = new DatabaseProxy(this, "Proxy", new DatabaseProxyProps {
                 ProxyTarget = ProxyTarget.FromInstance(instance),
                 Vpc = vpc,
                 DefaultAuthScheme = DefaultAuthScheme.IAM_AUTH
             });

             // Grant IAM permissions for database connection
             var role = new Role(this, "DBRole", new RoleProps { AssumedBy = new AccountPrincipal(Account) });
             proxy.GrantConnect(role, "database-user");

Synopsis

Methods

Bind(DatabaseProxy)	Bind this target to the specified database proxy.
FromCluster(IDatabaseCluster)	From cluster.
FromInstance(IDatabaseInstance)	From instance.

Methods

Bind(DatabaseProxy)

Bind this target to the specified database proxy.

public virtual IProxyTargetConfig Bind(DatabaseProxy proxy)

Parameters

proxy DatabaseProxy

Returns

IProxyTargetConfig

Remarks

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

FromCluster(IDatabaseCluster)

From cluster.

public static ProxyTarget FromCluster(IDatabaseCluster cluster)

Parameters

cluster IDatabaseCluster

RDS database cluster.

Returns

ProxyTarget

Remarks

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

FromInstance(IDatabaseInstance)

From instance.

public static ProxyTarget FromInstance(IDatabaseInstance instance)

Parameters

instance IDatabaseInstance

RDS database instance.

Returns

ProxyTarget

Remarks

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