interface AuthFormatProperty

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html

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

Properties

Name	Type	Description
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.
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.

---

authScheme?

Type: string (optional)

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme

---

clientPasswordAuthType?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-clientpasswordauthtype

---

description?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-description

---

iamAuth?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-secretarn