java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.redshift.model.RedshiftRequest
    - - software.amazon.awssdk.services.redshift.model.GetClusterCredentialsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetClusterCredentialsRequest
extends RedshiftRequest
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`autoCreate()`	Create a database user with the name specified for the user named in `DbUser` if one does not exist.
`static GetClusterCredentialsRequest.Builder`	`builder()`
`String`	`clusterIdentifier()`	The unique identifier of the cluster that contains the database for which you are requesting credentials.
`String`	`customDomainName()`	The custom domain name for the cluster credentials.
`List<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.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDbGroups()`	For responses, this returns true if the service returned a value for the DbGroups property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetClusterCredentialsRequest.Builder>`	`serializableBuilderClass()`
`GetClusterCredentialsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbUser
```
public final 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.
    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.
  - dbName
```
public final 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.
    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.
  - clusterIdentifier
```
public final String clusterIdentifier()
```
    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.
  - durationSeconds
```
public final 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 final Boolean autoCreate()
```
    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.
  - hasDbGroups
```
public final boolean hasDbGroups()
```
    For responses, this returns true if the service returned a value for the DbGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dbGroups
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDbGroups() method.
    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.
  - customDomainName
```
public final String customDomainName()
```
    The custom domain name for the cluster credentials.
    
    Returns:
    
    The custom domain name for the cluster credentials.
  - toBuilder
```
public GetClusterCredentialsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>
    
    Specified by:
    
    toBuilder in class RedshiftRequest
  - builder
```
public static GetClusterCredentialsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetClusterCredentialsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetClusterCredentialsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

dbUser

dbName

clusterIdentifier

durationSeconds

autoCreate

hasDbGroups

dbGroups

customDomainName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields