Package software.amazon.awssdk.services.rds.model

Interface UserAuthConfigInfo.Builder

    • Method Detail

      • description

        UserAuthConfigInfo.Builder description​(String description)

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

        Parameters:
        description - A user-specified description about the authentication used by a proxy to log in as a specific database user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userName

        UserAuthConfigInfo.Builder userName​(String userName)

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

        Parameters:
        userName - The name of the database user to which the proxy connects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authScheme

        UserAuthConfigInfo.Builder authScheme​(String authScheme)

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

        Parameters:
        authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthScheme, AuthScheme

      • authScheme

        UserAuthConfigInfo.Builder authScheme​(AuthScheme authScheme)

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

        Parameters:
        authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthScheme, AuthScheme

      • secretArn

        UserAuthConfigInfo.Builder secretArn​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamAuth

        UserAuthConfigInfo.Builder iamAuth​(String iamAuth)

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

        Parameters:
        iamAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IAMAuthMode, IAMAuthMode

      • iamAuth

        UserAuthConfigInfo.Builder iamAuth​(IAMAuthMode iamAuth)

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

        Parameters:
        iamAuth - Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IAMAuthMode, IAMAuthMode

      • clientPasswordAuthType

        UserAuthConfigInfo.Builder clientPasswordAuthType​(String clientPasswordAuthType)

        The type of authentication the proxy uses for connections from clients.

        Parameters:
        clientPasswordAuthType - The type of authentication the proxy uses for connections from clients.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClientPasswordAuthType, ClientPasswordAuthType