Skip to content

Data Source: awsDbProxy

Use this data source to get information about a DB Proxy.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsDbProxy.DataAwsDbProxy(this, "proxy", {
  name: "my-test-db-proxy",
});

Argument Reference

The following arguments are supported:

  • name - (Required) Name of the DB proxy.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - ARN of the DB Proxy.
  • auth - Configuration(s) with authorization mechanisms to connect to the associated instance or cluster.
  • debugLogging - Whether the proxy includes detailed information about SQL statements in its logs.
  • endpoint - Endpoint that you can use to connect to the DB proxy.
  • engineFamily - Kinds of databases that the proxy can connect to.
  • idleClientTimeout - Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
  • requireTls - Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
  • roleArn - ARN for the IAM role that the proxy uses to access Amazon Secrets Manager.
  • vpcId - Provides the VPC ID of the DB proxy.
  • vpcSecurityGroupIds - Provides a list of VPC security groups that the proxy belongs to.
  • vpcSubnetIds - EC2 subnet IDs for the proxy.