Interface GetClusterCredentialsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetClusterCredentialsRequest.Builder,
,GetClusterCredentialsRequest> RedshiftRequest.Builder
,SdkBuilder<GetClusterCredentialsRequest.Builder,
,GetClusterCredentialsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetClusterCredentialsRequest
-
Method Summary
Modifier and TypeMethodDescriptionautoCreate
(Boolean autoCreate) Create a database user with the name specified for the user named inDbUser
if one does not exist.clusterIdentifier
(String clusterIdentifier) The unique identifier of the cluster that contains the database for which you are requesting credentials.customDomainName
(String customDomainName) The custom domain name for the cluster credentials.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.dbGroups
(Collection<String> 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.The name of a database thatDbUser
is authorized to log on to.The name of a database user.durationSeconds
(Integer durationSeconds) The number of seconds until the returned temporary password expires.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.services.redshift.model.RedshiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.
- Parameters:
dbUser
- The name of a database user. If a user name matchingDbUser
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
dbName
- The name of a database thatDbUser
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
-
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
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 inDbUser
if one does not exist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 inDbUser
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
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 inDbUser
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.
-
-
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.
-
overrideConfiguration
GetClusterCredentialsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-