com.amazonaws.services.redshift.model

Class GetClusterCredentialsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.GetClusterCredentialsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetClusterCredentialsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request parameters to get cluster credentials.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetClusterCredentialsRequest()

Method Summary

Modifier and Type	Method and Description
GetClusterCredentialsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAutoCreate() Create a database user with the name specified for the user named in DbUser if one does not exist.
String	getClusterIdentifier() The unique identifier of the cluster that contains the database for which you are requesting credentials.
String	getCustomDomainName() The custom domain name for the cluster credentials.
List<String>	getDbGroups() 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.
String	getDbName() The name of a database that DbUser is authorized to log on to.
String	getDbUser() The name of a database user.
Integer	getDurationSeconds() The number of seconds until the returned temporary password expires.
int	hashCode()
Boolean	isAutoCreate() Create a database user with the name specified for the user named in DbUser if one does not exist.
void	setAutoCreate(Boolean autoCreate) Create a database user with the name specified for the user named in DbUser if one does not exist.
void	setClusterIdentifier(String clusterIdentifier) The unique identifier of the cluster that contains the database for which you are requesting credentials.
void	setCustomDomainName(String customDomainName) The custom domain name for the cluster credentials.
void	setDbGroups(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.
void	setDbName(String dbName) The name of a database that DbUser is authorized to log on to.
void	setDbUser(String dbUser) The name of a database user.
void	setDurationSeconds(Integer durationSeconds) The number of seconds until the returned temporary password expires.
String	toString() Returns a string representation of this object.
GetClusterCredentialsRequest	withAutoCreate(Boolean autoCreate) Create a database user with the name specified for the user named in DbUser if one does not exist.
GetClusterCredentialsRequest	withClusterIdentifier(String clusterIdentifier) The unique identifier of the cluster that contains the database for which you are requesting credentials.
GetClusterCredentialsRequest	withCustomDomainName(String customDomainName) The custom domain name for the cluster credentials.
GetClusterCredentialsRequest	withDbGroups(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	withDbGroups(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	withDbName(String dbName) The name of a database that DbUser is authorized to log on to.
GetClusterCredentialsRequest	withDbUser(String dbUser) The name of a database user.
GetClusterCredentialsRequest	withDurationSeconds(Integer durationSeconds) The number of seconds until the returned temporary password expires.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetClusterCredentialsRequest

public GetClusterCredentialsRequest()

Method Detail

setDbUser

public void setDbUser(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. The user name can't be PUBLIC.

• Must contain uppercase or 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. The user name can't be PUBLIC.

• Must contain uppercase or 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.

getDbUser

public String getDbUser()

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. The user name can't be PUBLIC.

• Must contain uppercase or 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:

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. The user name can't be PUBLIC.

• Must contain uppercase or 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.

withDbUser

public GetClusterCredentialsRequest withDbUser(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. The user name can't be PUBLIC.

• Must contain uppercase or 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. The user name can't be PUBLIC.

• Must contain uppercase or 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.

setDbName

public void setDbName(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 uppercase or 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 uppercase or 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.

getDbName

public String getDbName()

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 uppercase or 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:

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 uppercase or 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.

withDbName

public GetClusterCredentialsRequest withDbName(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 uppercase or 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 uppercase or 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.

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

getClusterIdentifier

public String getClusterIdentifier()

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

Returns:

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

withClusterIdentifier

public GetClusterCredentialsRequest withClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

Returns:

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

setDurationSeconds

public void setDurationSeconds(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

getDurationSeconds

public Integer getDurationSeconds()

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

withDurationSeconds

public GetClusterCredentialsRequest withDurationSeconds(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.

setAutoCreate

public void setAutoCreate(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.

getAutoCreate

public Boolean getAutoCreate()

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

Returns:

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

withAutoCreate

public GetClusterCredentialsRequest withAutoCreate(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.

isAutoCreate

public Boolean isAutoCreate()

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

Returns:

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

getDbGroups

public List<String> getDbGroups()

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:

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.

setDbGroups

public void setDbGroups(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.

withDbGroups

public GetClusterCredentialsRequest withDbGroups(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.

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

withDbGroups

public GetClusterCredentialsRequest withDbGroups(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.

setCustomDomainName

public void setCustomDomainName(String customDomainName)

The custom domain name for the cluster credentials.

Parameters:

customDomainName - The custom domain name for the cluster credentials.

getCustomDomainName

public String getCustomDomainName()

The custom domain name for the cluster credentials.

Returns:

The custom domain name for the cluster credentials.

withCustomDomainName

public GetClusterCredentialsRequest withCustomDomainName(String customDomainName)

The custom domain name for the cluster credentials.

Parameters:

customDomainName - The custom domain name for the cluster credentials.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetClusterCredentialsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()