Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.
See https://www.paws-r-sdk.com/docs/redshift_get_cluster_credentials/ for full documentation.
redshift_get_cluster_credentials(
DbUser,
DbName = NULL,
ClusterIdentifier = NULL,
DurationSeconds = NULL,
AutoCreate = NULL,
DbGroups = NULL,
CustomDomainName = NULL
)[required] 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.
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.
The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.
The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
Create a database user with the name specified for the user named in
DbUser if one does not exist.
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.
The custom domain name for the cluster credentials.