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

Class GetClusterCredentialsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.redshift.model.GetClusterCredentialsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetClusterCredentialsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

The request parameters to get cluster credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetClusterCredentialsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
Boolean	autoCreate()	Create a database user with the name specified for DbUser if one does not exist.
static GetClusterCredentialsRequest.Builder	builder()
String	clusterIdentifier()	The unique identifier of the cluster that contains the database for which your are requesting credentials.
List<String>	dbGroups()	A list of the names of existing database groups that DbUser will join for the current session.
String	dbName()	The name of a database that DbUser is authorized to log on to.
String	dbUser()	The name of a database user.
Integer	durationSeconds()	The number of seconds until the returned temporary password expires.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends GetClusterCredentialsRequest.Builder>	serializableBuilderClass()
GetClusterCredentialsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dbUser

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

Returns:

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.

dbName

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

Returns:

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.

clusterIdentifier

public String clusterIdentifier()

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

Returns:

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

durationSeconds

public Integer durationSeconds()

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Returns:

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

autoCreate

public Boolean autoCreate()

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

Returns:

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

dbGroups

public List<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.

Returns:

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.

toBuilder

public GetClusterCredentialsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

Returns:

a builder for type T

builder

public static GetClusterCredentialsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetClusterCredentialsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object