Package software.amazon.awssdk.services.redshift.model

Interface GetClusterCredentialsRequest.Builder

All Superinterfaces:

CopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>, SdkBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

Enclosing class:

GetClusterCredentialsRequest

public static interface GetClusterCredentialsRequest.Builder
extends CopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

Method Summary

Modifier and Type	Method	Description
GetClusterCredentialsRequest.Builder	autoCreate(Boolean autoCreate)	Create a database user with the name specified for DbUser if one does not exist.
GetClusterCredentialsRequest.Builder	clusterIdentifier(String clusterIdentifier)	The unique identifier of the cluster that contains the database for which your are requesting credentials.
GetClusterCredentialsRequest.Builder	dbGroups(String... dbGroups)	A list of the names of existing database groups that DbUser will join for the current session.
GetClusterCredentialsRequest.Builder	dbGroups(Collection<String> dbGroups)	A list of the names of existing database groups that DbUser will join for the current session.
GetClusterCredentialsRequest.Builder	dbName(String dbName)	The name of a database that DbUser is authorized to log on to.
GetClusterCredentialsRequest.Builder	dbUser(String dbUser)	The name of a database user.
GetClusterCredentialsRequest.Builder	durationSeconds(Integer durationSeconds)	The number of seconds until the returned temporary password expires.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

dbUser

GetClusterCredentialsRequest.Builder dbUser(String dbUser)

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.

For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

Constraints:

• Must be 1 to 128 alphanumeric characters or hyphens

• Must contain only lowercase letters.

• First character must be a letter.

• Must not contain a colon ( : ) or slash ( / ).

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Parameters:

dbUser - 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.

For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

Constraints:

• Must be 1 to 128 alphanumeric characters or hyphens

• Must contain only lowercase letters.

• First character must be a letter.

• Must not contain a colon ( : ) or slash ( / ).

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbName

GetClusterCredentialsRequest.Builder dbName(String dbName)

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

Constraints:

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters.

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Parameters:

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

Constraints:

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters.

• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterIdentifier

GetClusterCredentialsRequest.Builder clusterIdentifier(String clusterIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

durationSeconds

GetClusterCredentialsRequest.Builder durationSeconds(Integer durationSeconds)

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Parameters:

durationSeconds - The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Returns:

Returns a reference to this object so that method calls can be chained together.

autoCreate

GetClusterCredentialsRequest.Builder autoCreate(Boolean autoCreate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dbGroups

GetClusterCredentialsRequest.Builder dbGroups(Collection<String> dbGroups)

A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

Parameters:

dbGroups - A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbGroups

GetClusterCredentialsRequest.Builder dbGroups(String... dbGroups)

A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

NOTE: This method appends the values to the existing list (if any). Use #setDbGroups(java.util.Collection) or #withDbGroups(java.util.Collection) if you want to override the existing values.

Parameters:

dbGroups - A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

Returns:

Returns a reference to this object so that method calls can be chained together.