db_proxies

Creates, updates, deletes or gets a db_proxy resource or lists db_proxies in a region

Overview

Name	db_proxies
Type	Resource
Description	Resource schema for AWS::RDS::DBProxy
Id	aws.rds.db_proxies

Fields

Name	Datatype	Description
auth	array	The authorization mechanism that the proxy uses.
db_proxy_arn	string	The Amazon Resource Name (ARN) for the proxy.
db_proxy_name	string	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	boolean	Whether the proxy includes detailed information about SQL statements in its logs.
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.
engine_family	string	The kinds of databases that the proxy can connect to.
idle_client_timeout	integer	The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
require_tls	boolean	A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
tags	array	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpc_id	string	VPC ID to associate with the new DB proxy.
vpc_security_group_ids	array	VPC security group IDs to associate with the new proxy.
vpc_subnet_ids	array	VPC subnet IDs to associate with the new proxy.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Auth, DBProxyName, EngineFamily, RoleArn, VpcSubnetIds, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all db_proxies in a region.

SELECT
region,
auth,
db_proxy_arn,
db_proxy_name,
debug_logging,
endpoint,
engine_family,
idle_client_timeout,
require_tls,
role_arn,
tags,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.rds.db_proxies
WHERE region = 'us-east-1';

Gets all properties from an individual db_proxy.

SELECT
region,
auth,
db_proxy_arn,
db_proxy_name,
debug_logging,
endpoint,
engine_family,
idle_client_timeout,
require_tls,
role_arn,
tags,
vpc_id,
vpc_security_group_ids,
vpc_subnet_ids
FROM aws.rds.db_proxies
WHERE region = 'us-east-1' AND data__Identifier = '<DBProxyName>';

INSERT example

Use the following StackQL query and manifest file to create a new db_proxy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.rds.db_proxies (
 Auth,
 DBProxyName,
 EngineFamily,
 RoleArn,
 VpcSubnetIds,
 region
)
SELECT 
'{{ Auth }}',
 '{{ DBProxyName }}',
 '{{ EngineFamily }}',
 '{{ RoleArn }}',
 '{{ VpcSubnetIds }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_proxies (
 Auth,
 DBProxyName,
 DebugLogging,
 EngineFamily,
 IdleClientTimeout,
 RequireTLS,
 RoleArn,
 Tags,
 VpcSecurityGroupIds,
 VpcSubnetIds,
 region
)
SELECT 
 '{{ Auth }}',
 '{{ DBProxyName }}',
 '{{ DebugLogging }}',
 '{{ EngineFamily }}',
 '{{ IdleClientTimeout }}',
 '{{ RequireTLS }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ VpcSecurityGroupIds }}',
 '{{ VpcSubnetIds }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_proxy
    props:
      - name: Auth
        value:
          - AuthScheme: '{{ AuthScheme }}'
            Description: '{{ Description }}'
            IAMAuth: '{{ IAMAuth }}'
            SecretArn: '{{ SecretArn }}'
            ClientPasswordAuthType: '{{ ClientPasswordAuthType }}'
      - name: DBProxyName
        value: '{{ DBProxyName }}'
      - name: DebugLogging
        value: '{{ DebugLogging }}'
      - name: EngineFamily
        value: '{{ EngineFamily }}'
      - name: IdleClientTimeout
        value: '{{ IdleClientTimeout }}'
      - name: RequireTLS
        value: '{{ RequireTLS }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: VpcSecurityGroupIds
        value:
          - '{{ VpcSecurityGroupIds[0] }}'
      - name: VpcSubnetIds
        value:
          - '{{ VpcSubnetIds[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.rds.db_proxies
WHERE data__Identifier = '<DBProxyName>'
AND region = 'us-east-1';

Permissions

To operate on the db_proxies resource, the following permissions are required:

Create

rds:CreateDBProxy,
rds:DescribeDBProxies,
iam:PassRole

Read

rds:DescribeDBProxies

Update

rds:ModifyDBProxy,
rds:AddTagsToResource,
rds:RemoveTagsFromResource,
iam:PassRole

Delete

rds:DescribeDBProxies,
rds:DeleteDBProxy

List

rds:DescribeDBProxies