class CfnDBProxy (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.CfnDBProxy`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnDBProxy`
Java	`software.amazon.awscdk.services.rds.CfnDBProxy`
Python	`aws_cdk.aws_rds.CfnDBProxy`
TypeScript	`aws-cdk-lib` » `aws_rds` » `CfnDBProxy`

Implements IConstruct, IDependable, IInspectable, ITaggableV2

The AWS::RDS::DBProxy resource creates or updates a DB proxy.

For information about RDS Proxy for Amazon RDS, see Managing Connections with Amazon RDS Proxy in the Amazon RDS User Guide .

For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy in the Amazon Aurora User Guide .

Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.

For information about limitations that apply to RDS Proxy for Amazon RDS, see Limitations for RDS Proxy in the Amazon RDS User Guide .

For information about that apply to RDS Proxy for Amazon Aurora, see Limitations for RDS Proxy in the Amazon Aurora User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDBProxy = new rds.CfnDBProxy(this, 'MyCfnDBProxy', {
  auth: [{
    authScheme: 'authScheme',
    clientPasswordAuthType: 'clientPasswordAuthType',
    description: 'description',
    iamAuth: 'iamAuth',
    secretArn: 'secretArn',
  }],
  dbProxyName: 'dbProxyName',
  engineFamily: 'engineFamily',
  roleArn: 'roleArn',
  vpcSubnetIds: ['vpcSubnetIds'],

  // the properties below are optional
  debugLogging: false,
  idleClientTimeout: 123,
  requireTls: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

Initializer

new CfnDBProxy(scope: Construct, id: string, props: CfnDBProxyProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnDBProxyProps — Resource properties.

Construct Props

Name	Type	Description
auth	`IResolvable` `\|` `IResolvable` `\|` `AuthFormatProperty[]`	The authorization mechanism that the proxy uses.
dbProxyName	`string`	The identifier for the proxy.
engineFamily	`string`	The kinds of databases that the proxy can connect to.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
vpcSubnetIds	`string[]`	One or more VPC subnet IDs to associate with the new proxy.
debugLogging?	`boolean \|` `IResolvable`	Specifies 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 \|` `IResolvable`	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags?	`TagFormatProperty[]`	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpcSecurityGroupIds?	`string[]`	One or more VPC security group IDs to associate with the new proxy.

auth

Type: IResolvable | IResolvable | AuthFormatProperty[]

The authorization mechanism that the proxy uses.

dbProxyName

Type: string

The identifier for the proxy.

This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

engineFamily

Type: string

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. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL . For RDS for Microsoft SQL Server, specify SQLSERVER .

roleArn

Type: string

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

vpcSubnetIds

Type: string[]

One or more VPC subnet IDs to associate with the new proxy.

debugLogging?

Type: boolean | IResolvable (optional)

Specifies 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.

idleClientTimeout?

Type: number (optional)

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

You can set this value higher or lower than the connection timeout limit for the associated database.

requireTls?

Type: boolean | IResolvable (optional)

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

By enabling this setting, you can enforce encrypted TLS connections to the proxy.

tags?

Type: TagFormatProperty[] (optional)

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

vpcSecurityGroupIds?

Type: string[] (optional)

One or more VPC security group IDs to associate with the new proxy.

If you plan to update the resource, don't specify VPC security groups in a shared VPC.

Properties

Name	Type	Description
attrDbProxyArn	`string`	The Amazon Resource Name (ARN) for the proxy.
attrEndpoint	`string`	The endpoint that you can use to connect to the DB proxy.
attrVpcId	`string`	The VPC ID to associate with the DB proxy.
auth	`IResolvable` `\|` `IResolvable` `\|` `AuthFormatProperty[]`	The authorization mechanism that the proxy uses.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
dbProxyName	`string`	The identifier for the proxy.
engineFamily	`string`	The kinds of databases that the proxy can connect to.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
stack	`Stack`	The stack in which this element is defined.
vpcSubnetIds	`string[]`	One or more VPC subnet IDs to associate with the new proxy.
debugLogging?	`boolean \|` `IResolvable`	Specifies 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 \|` `IResolvable`	Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
tags?	`TagFormatProperty[]`	An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
vpcSecurityGroupIds?	`string[]`	One or more VPC security group IDs to associate with the new proxy.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrDbProxyArn

Type: string

The Amazon Resource Name (ARN) for the proxy.

attrEndpoint

Type: string

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.

attrVpcId

Type: string

The VPC ID to associate with the DB proxy.

auth

Type: IResolvable | IResolvable | AuthFormatProperty[]

The authorization mechanism that the proxy uses.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

dbProxyName

Type: string

The identifier for the proxy.

engineFamily

Type: string

The kinds of databases that the proxy can connect to.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

vpcSubnetIds

Type: string[]

One or more VPC subnet IDs to associate with the new proxy.

debugLogging?

Type: boolean | IResolvable (optional)

Specifies whether the proxy includes detailed information about SQL statements in its logs.

idleClientTimeout?

Type: number (optional)

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

requireTls?

Type: boolean | IResolvable (optional)

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

tags?

Type: TagFormatProperty[] (optional)

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

vpcSecurityGroupIds?

Type: string[] (optional)

One or more VPC security group IDs to associate with the new proxy.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }