Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-rds-dbproxy.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS::RDS::DBProxy. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

Auth AuthFormat[] required

The authorization mechanism that the proxy uses.

minItems=1
DBProxyName string | Aws_CF_FunctionString required

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

EngineFamily string | Aws_CF_FunctionString required

The kinds of databases that the proxy can connect to.

RoleArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

VpcSubnetIds string[] required

VPC subnet IDs to associate with the new proxy.

minItems=2
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.

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.

minItems=1

Definitions

AuthFormat object
AuthScheme string | Aws_CF_FunctionString

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

Description string | Aws_CF_FunctionString

A user-specified description about the authentication used by a proxy to log in as a specific database user.

IAMAuth string | Aws_CF_FunctionString

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 | Aws_CF_FunctionString

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.

ClientPasswordAuthType string | Aws_CF_FunctionString

The type of authentication the proxy uses for connections from clients.

TagFormat object
Key string | Aws_CF_FunctionString
Value string | Aws_CF_FunctionString