Interface CfnDBProxy.IAuthFormatProperty

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

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public interface IAuthFormatProperty

Syntax (vb)

Public Interface IAuthFormatProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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"
};

Synopsis

Properties

AuthScheme	The type of authentication that the proxy uses for connections from the proxy to the underlying database.
ClientPasswordAuthType	Specifies the details of authentication used by a proxy to log in as a specific database user.
Description	A user-specified description about the authentication used by a proxy to log in as a specific database user.
IamAuth	Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
SecretArn	The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.

Properties

AuthScheme

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

virtual string AuthScheme { get; }

Property Value

System.String

Remarks

Valid Values: SECRETS

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

ClientPasswordAuthType

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

virtual string ClientPasswordAuthType { get; }

Property Value

System.String

Remarks

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

Description

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

virtual string Description { get; }

Property Value

System.String

Remarks

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

IamAuth

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

virtual string IamAuth { get; }

Property Value

System.String

Remarks

The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

Valid Values: ENABLED | DISABLED | REQUIRED

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

SecretArn

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.

virtual string SecretArn { get; }

Property Value

System.String

Remarks

These secrets are stored within Amazon Secrets Manager.

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