AWS::RDS::DBProxy AuthFormat - AWS CloudFormation

AWS::RDS::DBProxy AuthFormat

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "AuthScheme" : String, "Description" : String, "IAMAuth" : String, "SecretArn" : String, "UserName" : String }

YAML

AuthScheme: String Description: String IAMAuth: String SecretArn: String UserName: String

Properties

AuthScheme

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

Valid Values: SECRETS

Required: No

Type: String

Update requires: No interruption

Description

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

Required: No

Type: String

Update requires: No interruption

IAMAuth

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Valid Values: DISABLED | REQUIRED

Required: No

Type: String

Update requires: No interruption

SecretArn

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.

Required: No

Type: String

Update requires: No interruption

UserName

The name of the database user to which the proxy connects.

Required: No

Type: String

Update requires: No interruption