GetClusterCredentialsRequest

The request parameters to get cluster credentials.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Create a database user with the name specified for the user named in DbUser if one does not exist.

Link copied to clipboard

The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.

Link copied to clipboard

The custom domain name for the cluster credentials.

Link copied to clipboard

A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

Link copied to clipboard

The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

Link copied to clipboard

The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

Link copied to clipboard

The number of seconds until the returned temporary password expires.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String