public static interface GetClusterCredentialsRequest.Builder extends RedshiftRequest.Builder, CopyableBuilder<GetClusterCredentialsRequest.Builder,GetClusterCredentialsRequest>
| Modifier and Type | Method and Description |
|---|---|
GetClusterCredentialsRequest.Builder |
autoCreate(Boolean autoCreate)
Create a database user with the name specified for the user named in
DbUser if one does not
exist. |
GetClusterCredentialsRequest.Builder |
clusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster that contains the database for which your are requesting credentials.
|
GetClusterCredentialsRequest.Builder |
dbGroups(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.Builder |
dbGroups(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.Builder |
dbName(String dbName)
The name of a database that
DbUser is authorized to log on to. |
GetClusterCredentialsRequest.Builder |
dbUser(String dbUser)
The name of a database user.
|
GetClusterCredentialsRequest.Builder |
durationSeconds(Integer durationSeconds)
The number of seconds until the returned temporary password expires.
|
GetClusterCredentialsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
GetClusterCredentialsRequest.Builder |
requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)
Add an optional request override configuration.
|
buildrequestOverrideConfigcopyapply, buildGetClusterCredentialsRequest.Builder dbUser(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
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.
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
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.
GetClusterCredentialsRequest.Builder dbName(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 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.
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 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.
GetClusterCredentialsRequest.Builder clusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
clusterIdentifier - The unique identifier of the cluster that contains the database for which your are requesting
credentials. This parameter is case sensitive.GetClusterCredentialsRequest.Builder durationSeconds(Integer durationSeconds)
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
durationSeconds - The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
GetClusterCredentialsRequest.Builder autoCreate(Boolean autoCreate)
Create a database user with the name specified for the user named in DbUser if one does not
exist.
autoCreate - Create a database user with the name specified for the user named in DbUser if one does
not exist.GetClusterCredentialsRequest.Builder dbGroups(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.
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.
GetClusterCredentialsRequest.Builder dbGroups(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.
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.
GetClusterCredentialsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.BuilderrequestOverrideConfig in interface AwsRequest.BuilderawsRequestOverrideConfig - The override configuration.GetClusterCredentialsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)
AwsRequest.BuilderrequestOverrideConfig in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.