Skip to content
v2.277.0

AuthFormatProperty Struct ​

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

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

auth_format_property = rds.CfnDBProxy.AuthFormatProperty(
    auth_scheme="authScheme",
    client_password_auth_type="clientPasswordAuthType",
    description="description",
    iam_auth="iamAuth",
    secret_arn="secretArn"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;

AuthFormatProperty authFormatProperty = AuthFormatProperty.builder()
        .authScheme("authScheme")
        .clientPasswordAuthType("clientPasswordAuthType")
        .description("description")
        .iamAuth("iamAuth")
        .secretArn("secretArn")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;

var authFormatProperty = new AuthFormatProperty {
    AuthScheme = "authScheme",
    ClientPasswordAuthType = "clientPasswordAuthType",
    Description = "description",
    IamAuth = "iamAuth",
    SecretArn = "secretArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

authFormatProperty := &AuthFormatProperty{
	AuthScheme: jsii.String("authScheme"),
	ClientPasswordAuthType: jsii.String("clientPasswordAuthType"),
	Description: jsii.String("description"),
	IamAuth: jsii.String("iamAuth"),
	SecretArn: jsii.String("secretArn"),
}

Properties ​

authSchemeoptionalstringauth_schemeoptionalstrauthSchemeoptionalStringAuthSchemeoptionalstringAuthSchemeoptional*string#
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
clientPasswordAuthTypeoptionalstringclient_password_auth_typeoptionalstrclientPasswordAuthTypeoptionalStringClientPasswordAuthTypeoptionalstringClientPasswordAuthTypeoptional*string#
Specifies the details of authentication used by a proxy to log in as a specific database user.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A user-specified description about the authentication used by a proxy to log in as a specific database user.
iamAuthoptionalstringiam_authoptionalstriamAuthoptionalStringIamAuthoptionalstringIamAuthoptional*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.

secretArnoptionalstringsecret_arnoptionalstrsecretArnoptionalStringSecretArnoptionalstringSecretArnoptional*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.