Class DatabaseProxy

RDS Database Proxy.

Inheritance
object
Resource
DatabaseProxy
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseProxy : Resource, IConnectable, ISecretAttachmentTarget, IDatabaseProxy, IResource, IConstruct, IDependable
Syntax (vb)
Public Class DatabaseProxy Inherits Resource Implements IConnectable, ISecretAttachmentTarget, IDatabaseProxy, IResource, IConstruct, IDependable
Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

Examples
Vpc vpc;

             var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
                 Engine = DatabaseClusterEngine.AuroraMysql(new AuroraMysqlClusterEngineProps {
                     Version = AuroraMysqlEngineVersion.VER_3_03_0
                 }),
                 Writer = ClusterInstance.Provisioned("writer"),
                 Vpc = vpc
             });

             var proxy = new DatabaseProxy(this, "Proxy", new DatabaseProxyProps {
                 ProxyTarget = ProxyTarget.FromCluster(cluster),
                 Secrets = new [] { cluster.Secret },
                 Vpc = vpc,
                 ClientPasswordAuthType = ClientPasswordAuthType.MYSQL_NATIVE_PASSWORD
             });

Synopsis

Constructors

DatabaseProxy(Construct, string, IDatabaseProxyProps)

RDS Database Proxy.

Properties

Connections

Access to network connections.
DbProxyArn

DB Proxy ARN.
DbProxyName

DB Proxy Name.
Endpoint

Endpoint.
PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.
FromDatabaseProxyAttributes(Construct, string, IDatabaseProxyAttributes)

Import an existing database proxy.
GrantConnect(IGrantable, string?)

Grant the given identity connection access to the proxy.

Constructors

DatabaseProxy(Construct, string, IDatabaseProxyProps)

RDS Database Proxy.

public DatabaseProxy(Construct scope, string id, IDatabaseProxyProps props)
Parameters
scope Construct
id string
props IDatabaseProxyProps
Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

Examples
Vpc vpc;

             var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
                 Engine = DatabaseClusterEngine.AuroraMysql(new AuroraMysqlClusterEngineProps {
                     Version = AuroraMysqlEngineVersion.VER_3_03_0
                 }),
                 Writer = ClusterInstance.Provisioned("writer"),
                 Vpc = vpc
             });

             var proxy = new DatabaseProxy(this, "Proxy", new DatabaseProxyProps {
                 ProxyTarget = ProxyTarget.FromCluster(cluster),
                 Secrets = new [] { cluster.Secret },
                 Vpc = vpc,
                 ClientPasswordAuthType = ClientPasswordAuthType.MYSQL_NATIVE_PASSWORD
             });

Properties

Connections

Access to network connections.

public virtual Connections_ Connections { get; }
Property Value

Connections_

Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

DbProxyArn

DB Proxy ARN.

public virtual string DbProxyArn { get; }
Property Value

string

Remarks

Attribute: true

DbProxyName

DB Proxy Name.

public virtual string DbProxyName { get; }
Property Value

string

Remarks

Attribute: true

Endpoint

Endpoint.

public virtual string Endpoint { get; }
Property Value

string

Remarks

Attribute: true

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

Methods

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.

public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()
Returns

ISecretAttachmentTargetProps

Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

FromDatabaseProxyAttributes(Construct, string, IDatabaseProxyAttributes)

Import an existing database proxy.

public static IDatabaseProxy FromDatabaseProxyAttributes(Construct scope, string id, IDatabaseProxyAttributes attrs)
Parameters
scope Construct
id string
attrs IDatabaseProxyAttributes
Returns

IDatabaseProxy

Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

GrantConnect(IGrantable, string?)

Grant the given identity connection access to the proxy.

public virtual Grant GrantConnect(IGrantable grantee, string? dbUser = null)
Parameters
grantee IGrantable
dbUser string
Returns

Grant

Remarks

Resource: AWS::RDS::DBProxy

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable