aws_rds_proxy

account_id

Type: STRING

auth

Type: UNORDERED_LIST_STRUCT
Provider name: Auth
Description: One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

• auth_scheme
  Type: STRING
  Provider name: AuthScheme
  Description: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
  
• client_password_auth_type
  Type: STRING
  Provider name: ClientPasswordAuthType
  Description: The type of authentication the proxy uses for connections from clients.
  
• description
  Type: STRING
  Provider name: Description
  Description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
  
• iam_auth
  Type: STRING
  Provider name: IAMAuth
  Description: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
  
• secret_arn
  Type: STRING
  Provider name: SecretArn
  Description: 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.
  
• user_name
  Type: STRING
  Provider name: UserName
  Description: The name of the database user to which the proxy connects.
  

created_date

Type: TIMESTAMP
Provider name: CreatedDate
Description: The date and time when the proxy was first created.

db_proxy_arn

Type: STRING
Provider name: DBProxyArn
Description: The Amazon Resource Name (ARN) for the proxy.

db_proxy_name

Type: STRING
Provider name: DBProxyName
Description: The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

debug_logging

Type: BOOLEAN
Provider name: DebugLogging
Description: Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

endpoint

Type: STRING
Provider name: Endpoint
Description: The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

engine_family

Type: STRING
Provider name: EngineFamily
Description: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

idle_client_timeout

Type: INT32
Provider name: IdleClientTimeout
Description: The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)

Constraints: 1 to 28,800

require_tls

Type: BOOLEAN
Provider name: RequireTLS
Description: Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

role_arn

Type: STRING
Provider name: RoleArn
Description: The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

status

Type: STRING
Provider name: Status
Description: The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

tags

Type: UNORDERED_LIST_STRING

updated_date

Type: TIMESTAMP
Provider name: UpdatedDate
Description: The date and time when the proxy was last updated.

vpc_id

Type: STRING
Provider name: VpcId
Description: Provides the VPC ID of the DB proxy.

vpc_security_group_ids

Type: UNORDERED_LIST_STRING
Provider name: VpcSecurityGroupIds
Description: Provides a list of VPC security groups that the proxy belongs to.

vpc_subnet_ids

Type: UNORDERED_LIST_STRING
Provider name: VpcSubnetIds
Description: The EC2 subnet IDs for the proxy.