GetClusterCredentialsPlainArgs

data class GetClusterCredentialsPlainArgs(val autoCreate: Boolean? = null, val clusterIdentifier: String, val dbGroups: List<String>? = null, val dbName: String? = null, val dbUser: String, val durationSeconds: Int? = null) : ConvertibleToJava<GetClusterCredentialsPlainArgs>

A collection of arguments for invoking getClusterCredentials.

Constructors

Link copied to clipboard
constructor(autoCreate: Boolean? = null, clusterIdentifier: String, dbGroups: List<String>? = null, dbName: String? = null, dbUser: String, durationSeconds: Int? = null)

Properties

Link copied to clipboard
val autoCreate: Boolean? = null

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

Link copied to clipboard

Unique identifier of the cluster that contains the database for which your are requesting credentials.

Link copied to clipboard
val dbGroups: List<String>? = null

List of the names of existing database groups that the user named in db_user 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
val dbName: String? = null

Name of a database that DbUser is authorized to log on to. If db_name is not specified, db_user can log on to any existing database.

Link copied to clipboard

Name of a database user. If a user name matching db_user exists in the database, the temporary user credentials have the same permissions as the existing user. If db_user doesn't exist in the database and auto_create is True, a new user is created using the value for db_user with PUBLIC permissions. If a database user matching the value for db_user doesn't exist and not 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
val durationSeconds: Int? = null

The number of seconds until the returned temporary password expires. Valid values are between 900 and 3600. Default value is 900.

Functions

Link copied to clipboard
open override fun toJava(): GetClusterCredentialsPlainArgs