AwsRdsProxyArgs

interface AwsRdsProxyArgs {
connectionPool?: AwsRdsProxyConnectionPoolArgs;
engineFamily: 'MYSQL' | 'POSTGRESQL';
idleClientTimeout?: Input<number>;
name: string;
role: Role;
secret: Secret;
securityGroups: SecurityGroup[];
subnets: Subnet[];
tags?: AwsRdsTags;
target: AwsRdsProxyTargetReference;
}

Inputs for a private, TLS-enforced RDS Proxy targeting one Aurora cluster.

Remarks

The supplied IAM role must trust rds.amazonaws.com and allow secretsmanager:GetSecretValue for secret. The supplied secret must contain credentials for a database user accepted by the target cluster.

Example

CODE

import * as aws from '@pulumi/aws';

const buildProxy = (
  target: AwsRdsProxyTargetReference,
  role: aws.iam.Role,
  secret: aws.secretsmanager.Secret,
  securityGroups: aws.ec2.SecurityGroup[],
  subnets: aws.ec2.Subnet[],
): AwsRdsProxyArgs => ({
  name: 'ordersProxy',
  engineFamily: 'POSTGRESQL',
  target,
  role,
  secret,
  securityGroups,
  subnets,
});

Properties

`connectionPool: AwsRdsProxyConnectionPoolArgs`

Optional connection-pool configuration for the default proxy target group.

`engineFamily: 'MYSQL' | 'POSTGRESQL'`

Database protocol family. This must match the target Aurora cluster engine.

`idleClientTimeout: Input<number>`

Client connection idle timeout in seconds. Defaults to 1800.

`name: string`

Required camelCase provider naming purpose and synchronous logical identity.

`role: Role`

IAM role that permits RDS Proxy to retrieve the database credential secret.

`secret: Secret`

Secrets Manager secret containing credentials for the target database user.

`securityGroups: SecurityGroup[]`

Security groups controlling private client access to the proxy. At least one is required.

`subnets: Subnet[]`

Private subnets for the proxy. At least two distinct subnet references are required for availability; AWS validates their Availability Zone topology.

`tags: AwsRdsTags`

Additional tags. The Name tag is reserved.

`target: AwsRdsProxyTargetReference`

Aurora cluster reference and its plain target engine.