interface AuthFormatProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.RDS.CfnDBProxy.AuthFormatProperty |
 Java | software.amazon.awscdk.services.rds.CfnDBProxy.AuthFormatProperty |
 Python | aws_cdk.aws_rds.CfnDBProxy.AuthFormatProperty |
 TypeScript | @aws-cdk/aws-rds » CfnDBProxy » AuthFormatProperty |
Specifies the details of authentication used by a proxy to log in as a specific database user.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as rds from '@aws-cdk/aws-rds';
const authFormatProperty: rds.CfnDBProxy.AuthFormatProperty = {
authScheme: 'authScheme',
clientPasswordAuthType: 'clientPasswordAuthType',
description: 'description',
iamAuth: 'iamAuth',
secretArn: 'secretArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| auth | string | The type of authentication that the proxy uses for connections from the proxy to the underlying database. |
| client | 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. |
| iam | string | Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. |
| secret | string | The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. |
authScheme?
Type:
string
(optional)
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
Valid Values: SECRETS
clientPasswordAuthType?
Type:
string
(optional)
Specifies the details of authentication used by a proxy to log in as a specific database user.
description?
Type:
string
(optional)
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuth?
Type:
string
(optional)
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.
Valid Values: ENABLED | DISABLED | REQUIRED
secretArn?
Type:
string
(optional)
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.