software.amazon.awssdk.services.redshift.model

Interface GetClusterCredentialsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>, RedshiftRequest.Builder, SdkBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>, SdkRequest.Builder

Enclosing class:

GetClusterCredentialsRequest

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

Method Summary

Modifier and Type	Method and Description
GetClusterCredentialsRequest.Builder	autoCreate(Boolean autoCreate) Create a database user with the name specified for the user named in 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(Collection<String> dbGroups) 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.
GetClusterCredentialsRequest.Builder	dbGroups(String... dbGroups) 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.
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.
GetClusterCredentialsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetClusterCredentialsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, 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 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

• 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 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

• 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 on to any existing database.

Constraints:

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

• 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:

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

Constraints:

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

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

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 the user named in DbUser if one does not exist.

Parameters:

autoCreate - Create a database user with the name specified for the user named in 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 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.

Database group name constraints

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

• 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:

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

Database group name constraints

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

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

dbGroups

GetClusterCredentialsRequest.Builder dbGroups(String... dbGroups)

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.

Database group name constraints

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

• 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:

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

Database group name constraints

• Must be 1 to 64 alphanumeric characters or hyphens

• Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

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

overrideConfiguration

GetClusterCredentialsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetClusterCredentialsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.