Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. DbProxy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbProxy

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::RDS::DBProxy

Create DbProxy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbProxy(name: string, args: DbProxyArgs, opts?: CustomResourceOptions);
@overload
def DbProxy(resource_name: str,
            args: DbProxyArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def DbProxy(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auth: Optional[Sequence[DbProxyAuthFormatArgs]] = None,
            engine_family: Optional[DbProxyEngineFamily] = None,
            role_arn: Optional[str] = None,
            vpc_subnet_ids: Optional[Sequence[str]] = None,
            db_proxy_name: Optional[str] = None,
            debug_logging: Optional[bool] = None,
            idle_client_timeout: Optional[int] = None,
            require_tls: Optional[bool] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)
func NewDbProxy(ctx *Context, name string, args DbProxyArgs, opts ...ResourceOption) (*DbProxy, error)
public DbProxy(string name, DbProxyArgs args, CustomResourceOptions? opts = null)
public DbProxy(String name, DbProxyArgs args)
public DbProxy(String name, DbProxyArgs args, CustomResourceOptions options)

type: aws-native:rds:DbProxy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DbProxyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DbProxyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DbProxyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DbProxyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DbProxyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DbProxy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbProxy resource accepts the following input properties:

Auth This property is required. List<Pulumi.AwsNative.Rds.Inputs.DbProxyAuthFormat>
The authorization mechanism that the proxy uses.
EngineFamily This property is required. Pulumi.AwsNative.Rds.DbProxyEngineFamily
The kinds of databases that the proxy can connect to.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
VpcSubnetIds This property is required. List<string>
VPC subnet IDs to associate with the new proxy.
DbProxyName string
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
DebugLogging bool
Whether the proxy includes detailed information about SQL statements in its logs.
IdleClientTimeout int
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
RequireTls bool
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
VpcSecurityGroupIds List<string>
VPC security group IDs to associate with the new proxy.
Auth This property is required. []DbProxyAuthFormatArgs
The authorization mechanism that the proxy uses.
EngineFamily This property is required. DbProxyEngineFamily
The kinds of databases that the proxy can connect to.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
VpcSubnetIds This property is required. []string
VPC subnet IDs to associate with the new proxy.
DbProxyName string
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
DebugLogging bool
Whether the proxy includes detailed information about SQL statements in its logs.
IdleClientTimeout int
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
RequireTls bool
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
Tags TagArgs
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
VpcSecurityGroupIds []string
VPC security group IDs to associate with the new proxy.
auth This property is required. List<DbProxyAuthFormat>
The authorization mechanism that the proxy uses.
engineFamily This property is required. DbProxyEngineFamily
The kinds of databases that the proxy can connect to.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpcSubnetIds This property is required. List<String>
VPC subnet IDs to associate with the new proxy.
dbProxyName String
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debugLogging Boolean
Whether the proxy includes detailed information about SQL statements in its logs.
idleClientTimeout Integer
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
requireTls Boolean
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags List<Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpcSecurityGroupIds List<String>
VPC security group IDs to associate with the new proxy.
auth This property is required. DbProxyAuthFormat[]
The authorization mechanism that the proxy uses.
engineFamily This property is required. DbProxyEngineFamily
The kinds of databases that the proxy can connect to.
roleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpcSubnetIds This property is required. string[]
VPC subnet IDs to associate with the new proxy.
dbProxyName string
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debugLogging boolean
Whether the proxy includes detailed information about SQL statements in its logs.
idleClientTimeout number
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
requireTls boolean
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags Tag[]
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpcSecurityGroupIds string[]
VPC security group IDs to associate with the new proxy.
auth This property is required. Sequence[DbProxyAuthFormatArgs]
The authorization mechanism that the proxy uses.
engine_family This property is required. DbProxyEngineFamily
The kinds of databases that the proxy can connect to.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpc_subnet_ids This property is required. Sequence[str]
VPC subnet IDs to associate with the new proxy.
db_proxy_name str
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debug_logging bool
Whether the proxy includes detailed information about SQL statements in its logs.
idle_client_timeout int
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
require_tls bool
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags Sequence[TagArgs]
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpc_security_group_ids Sequence[str]
VPC security group IDs to associate with the new proxy.
auth This property is required. List<Property Map>
The authorization mechanism that the proxy uses.
engineFamily This property is required. "MYSQL" | "POSTGRESQL" | "SQLSERVER"
The kinds of databases that the proxy can connect to.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpcSubnetIds This property is required. List<String>
VPC subnet IDs to associate with the new proxy.
dbProxyName String
The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
debugLogging Boolean
Whether the proxy includes detailed information about SQL statements in its logs.
idleClientTimeout Number
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
requireTls Boolean
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags List<Property Map>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpcSecurityGroupIds List<String>
VPC security group IDs to associate with the new proxy.

Outputs

All input properties are implicitly available as output properties. Additionally, the DbProxy resource produces the following output properties:

DbProxyArn string
The Amazon Resource Name (ARN) for the proxy.
Endpoint string
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
Id string
The provider-assigned unique ID for this managed resource.
VpcId string
VPC ID to associate with the new DB proxy.
DbProxyArn string
The Amazon Resource Name (ARN) for the proxy.
Endpoint string
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
Id string
The provider-assigned unique ID for this managed resource.
VpcId string
VPC ID to associate with the new DB proxy.
dbProxyArn String
The Amazon Resource Name (ARN) for the proxy.
endpoint String
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
id String
The provider-assigned unique ID for this managed resource.
vpcId String
VPC ID to associate with the new DB proxy.
dbProxyArn string
The Amazon Resource Name (ARN) for the proxy.
endpoint string
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
id string
The provider-assigned unique ID for this managed resource.
vpcId string
VPC ID to associate with the new DB proxy.
db_proxy_arn str
The Amazon Resource Name (ARN) for the proxy.
endpoint str
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
id str
The provider-assigned unique ID for this managed resource.
vpc_id str
VPC ID to associate with the new DB proxy.
dbProxyArn String
The Amazon Resource Name (ARN) for the proxy.
endpoint String
The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
id String
The provider-assigned unique ID for this managed resource.
vpcId String
VPC ID to associate with the new DB proxy.

Supporting Types

DbProxyAuthFormat
, DbProxyAuthFormatArgs

AuthScheme Pulumi.AwsNative.Rds.DbProxyAuthFormatAuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
ClientPasswordAuthType Pulumi.AwsNative.Rds.DbProxyAuthFormatClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
Description string
A user-specified description about the authentication used by a proxy to log in as a specific database user.
IamAuth Pulumi.AwsNative.Rds.DbProxyAuthFormatIamAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
SecretArn string
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
AuthScheme DbProxyAuthFormatAuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
ClientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
Description string
A user-specified description about the authentication used by a proxy to log in as a specific database user.
IamAuth DbProxyAuthFormatIamAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
SecretArn string
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
authScheme DbProxyAuthFormatAuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
description String
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth DbProxyAuthFormatIamAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
secretArn String
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
authScheme DbProxyAuthFormatAuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType DbProxyAuthFormatClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
description string
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth DbProxyAuthFormatIamAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
secretArn string
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
auth_scheme DbProxyAuthFormatAuthScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
client_password_auth_type DbProxyAuthFormatClientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
description str
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iam_auth DbProxyAuthFormatIamAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
secret_arn str
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
authScheme "SECRETS"
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthType "MYSQL_NATIVE_PASSWORD" | "POSTGRES_SCRAM_SHA_256" | "POSTGRES_MD5" | "SQL_SERVER_AUTHENTICATION"
The type of authentication the proxy uses for connections from clients.
description String
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth "DISABLED" | "REQUIRED" | "ENABLED"
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
secretArn String
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

DbProxyAuthFormatAuthScheme
, DbProxyAuthFormatAuthSchemeArgs

Secrets
SECRETS
DbProxyAuthFormatAuthSchemeSecrets
SECRETS
Secrets
SECRETS
Secrets
SECRETS
SECRETS
SECRETS
"SECRETS"
SECRETS

DbProxyAuthFormatClientPasswordAuthType
, DbProxyAuthFormatClientPasswordAuthTypeArgs

MysqlNativePassword
MYSQL_NATIVE_PASSWORD
PostgresScramSha256
POSTGRES_SCRAM_SHA_256
PostgresMd5
POSTGRES_MD5
SqlServerAuthentication
SQL_SERVER_AUTHENTICATION
DbProxyAuthFormatClientPasswordAuthTypeMysqlNativePassword
MYSQL_NATIVE_PASSWORD
DbProxyAuthFormatClientPasswordAuthTypePostgresScramSha256
POSTGRES_SCRAM_SHA_256
DbProxyAuthFormatClientPasswordAuthTypePostgresMd5
POSTGRES_MD5
DbProxyAuthFormatClientPasswordAuthTypeSqlServerAuthentication
SQL_SERVER_AUTHENTICATION
MysqlNativePassword
MYSQL_NATIVE_PASSWORD
PostgresScramSha256
POSTGRES_SCRAM_SHA_256
PostgresMd5
POSTGRES_MD5
SqlServerAuthentication
SQL_SERVER_AUTHENTICATION
MysqlNativePassword
MYSQL_NATIVE_PASSWORD
PostgresScramSha256
POSTGRES_SCRAM_SHA_256
PostgresMd5
POSTGRES_MD5
SqlServerAuthentication
SQL_SERVER_AUTHENTICATION
MYSQL_NATIVE_PASSWORD
MYSQL_NATIVE_PASSWORD
POSTGRES_SCRAM_SHA256
POSTGRES_SCRAM_SHA_256
POSTGRES_MD5
POSTGRES_MD5
SQL_SERVER_AUTHENTICATION
SQL_SERVER_AUTHENTICATION
"MYSQL_NATIVE_PASSWORD"
MYSQL_NATIVE_PASSWORD
"POSTGRES_SCRAM_SHA_256"
POSTGRES_SCRAM_SHA_256
"POSTGRES_MD5"
POSTGRES_MD5
"SQL_SERVER_AUTHENTICATION"
SQL_SERVER_AUTHENTICATION

DbProxyAuthFormatIamAuth
, DbProxyAuthFormatIamAuthArgs

Disabled
DISABLED
Required
REQUIRED
Enabled
ENABLED
DbProxyAuthFormatIamAuthDisabled
DISABLED
DbProxyAuthFormatIamAuthRequired
REQUIRED
DbProxyAuthFormatIamAuthEnabled
ENABLED
Disabled
DISABLED
Required
REQUIRED
Enabled
ENABLED
Disabled
DISABLED
Required
REQUIRED
Enabled
ENABLED
DISABLED
DISABLED
REQUIRED
REQUIRED
ENABLED
ENABLED
"DISABLED"
DISABLED
"REQUIRED"
REQUIRED
"ENABLED"
ENABLED

DbProxyEngineFamily
, DbProxyEngineFamilyArgs

Mysql
MYSQL
Postgresql
POSTGRESQL
Sqlserver
SQLSERVER
DbProxyEngineFamilyMysql
MYSQL
DbProxyEngineFamilyPostgresql
POSTGRESQL
DbProxyEngineFamilySqlserver
SQLSERVER
Mysql
MYSQL
Postgresql
POSTGRESQL
Sqlserver
SQLSERVER
Mysql
MYSQL
Postgresql
POSTGRESQL
Sqlserver
SQLSERVER
MYSQL
MYSQL
POSTGRESQL
POSTGRESQL
SQLSERVER
SQLSERVER
"MYSQL"
MYSQL
"POSTGRESQL"
POSTGRESQL
"SQLSERVER"
SQLSERVER

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native