Class: AWSCDK::RDS::CfnDBProxy::AuthFormatProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_proxy.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_scheme: nil, client_password_auth_type: nil, description: nil, iam_auth: nil, secret_arn: nil) ⇒ AuthFormatProperty

Returns a new instance of AuthFormatProperty.

Parameters:

  • auth_scheme (String, nil) (defaults to: nil) —

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

  • client_password_auth_type (String, nil) (defaults to: nil) —

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

  • description (String, nil) (defaults to: nil) —

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

  • iam_auth (String, nil) (defaults to: nil) —

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

  • secret_arn (String, nil) (defaults to: nil) —

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



705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'rds/cfn_db_proxy.rb', line 705

def initialize(auth_scheme: nil, client_password_auth_type: nil, description: nil, iam_auth: nil, secret_arn: nil)
  @auth_scheme = auth_scheme
  Jsii::Type.check_type(@auth_scheme, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authScheme") unless @auth_scheme.nil?
  @client_password_auth_type = client_password_auth_type
  Jsii::Type.check_type(@client_password_auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientPasswordAuthType") unless @client_password_auth_type.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @iam_auth = iam_auth
  Jsii::Type.check_type(@iam_auth, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamAuth") unless @iam_auth.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#auth_scheme ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



722
723
724
 
# File 'rds/cfn_db_proxy.rb', line 722

def auth_scheme
  @auth_scheme
end

#client_password_auth_type ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



727
728
729
 
# File 'rds/cfn_db_proxy.rb', line 727

def client_password_auth_type
  @client_password_auth_type
end

#description ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



732
733
734
 
# File 'rds/cfn_db_proxy.rb', line 732

def description
  @description
end

#iam_auth ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



739
740
741
 
# File 'rds/cfn_db_proxy.rb', line 739

def iam_auth
  @iam_auth
end

#secret_arn ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



746
747
748
 
# File 'rds/cfn_db_proxy.rb', line 746

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object 



748
749
750
751
752
753
754
755
756
 
# File 'rds/cfn_db_proxy.rb', line 748

def self.jsii_properties
  {
    :auth_scheme => "authScheme",
    :client_password_auth_type => "clientPasswordAuthType",
    :description => "description",
    :iam_auth => "iamAuth",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



758
759
760
761
762
763
764
765
766
767
768
 
# File 'rds/cfn_db_proxy.rb', line 758

def to_jsii
  result = {}
  result.merge!({
    "authScheme" => @auth_scheme,
    "clientPasswordAuthType" => @client_password_auth_type,
    "description" => @description,
    "iamAuth" => @iam_auth,
    "secretArn" => @secret_arn,
  })
  result.compact
end