Class GetClusterCredentialsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetClusterCredentialsRequest.Builder,
GetClusterCredentialsRequest>
The request parameters to get cluster credentials.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Create a database user with the name specified for the user named inDbUser
if one does not exist.builder()
final String
The unique identifier of the cluster that contains the database for which you are requesting credentials.final String
The custom domain name for the cluster credentials.dbGroups()
A list of the names of existing database groups that the user named inDbUser
will join for the current session, in addition to any group memberships for an existing user.final String
dbName()
The name of a database thatDbUser
is authorized to log on to.final String
dbUser()
The name of a database user.final Integer
The number of seconds until the returned temporary password expires.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DbGroups property.final int
hashCode()
static Class
<? extends GetClusterCredentialsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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. IfDbUser
doesn't exist in the database andAutocreate
isTrue
, a new user is created using the value forDbUser
with PUBLIC permissions. If a database user matching the value forDbUser
doesn't exist andAutocreate
isFalse
, 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. IfDbUser
doesn't exist in the database andAutocreate
isTrue
, a new user is created using the value forDbUser
with PUBLIC permissions. If a database user matching the value forDbUser
doesn't exist andAutocreate
isFalse
, 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
The name of a database that
DbUser
is authorized to log on to. IfDbName
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. IfDbName
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
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
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
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 theisEmpty()
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
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
The custom domain name for the cluster credentials.
- Returns:
- The custom domain name for the cluster credentials.
-
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 interfaceToCopyableBuilder<GetClusterCredentialsRequest.Builder,
GetClusterCredentialsRequest> - Specified by:
toBuilder
in classRedshiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-