Class CfnDBProxy.AuthFormatProperty

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

Inheritance

object

CfnDBProxy.AuthFormatProperty

Implements

CfnDBProxy.IAuthFormatProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBProxy.AuthFormatProperty : CfnDBProxy.IAuthFormatProperty

Syntax (vb)

Public Class CfnDBProxy.AuthFormatProperty Implements CfnDBProxy.IAuthFormatProperty

Remarks

See: 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

Constructors

AuthFormatProperty()

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

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	A value that indicates 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.

Constructors

AuthFormatProperty()

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

public AuthFormatProperty()

Remarks

See: 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"
             };

Properties

AuthScheme

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

public string? AuthScheme { get; set; }

Property Value

string

Remarks

See: 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.

public string? ClientPasswordAuthType { get; set; }

Property Value

string

Remarks

See: 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.

public string? Description { get; set; }

Property Value

string

Remarks

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

IamAuth

A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

public string? IamAuth { get; set; }

Property Value

string

Remarks

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

See: 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.

public string? SecretArn { get; set; }

Property Value

string

Remarks

These secrets are stored within Amazon Secrets Manager.

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

Implements

CfnDBProxy.IAuthFormatProperty