# AuthFormatProperty

Specifies the details of authentication used by a proxy to log in as a specific database user.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

```ts
// 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 authFormatProperty: rds.CfnDBProxy.AuthFormatProperty = {
  authScheme: 'authScheme',
  clientPasswordAuthType: 'clientPasswordAuthType',
  description: 'description',
  iamAuth: 'iamAuth',
  secretArn: 'secretArn',
};
```

## Properties

- `authScheme`: string — The type of authentication that the proxy uses for connections from the proxy to the underlying database.

- `clientPasswordAuthType`: string — Specifies the details of authentication used by a proxy to log in as a specific database user.

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

- `iamAuth`: string — A value that indicates whether to require or disallow AWS 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 — 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.
