Get Cluster Credentials
redshift_get_cluster_credentials | R Documentation |
Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database¶
Description¶
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.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
If the DbGroups
parameter is specified, the IAM policy must allow the
redshift:JoinGroup
action with access to the listed dbgroups
.
In addition, if the AutoCreate
parameter is set to True
, then the
policy must include the redshift:CreateClusterUser
permission.
If the DbName
parameter is specified, the IAM policy must allow access
to the resource dbname
for the specified database name.
Usage¶
redshift_get_cluster_credentials(DbUser, DbName, ClusterIdentifier,
DurationSeconds, AutoCreate, DbGroups, CustomDomainName)
Arguments¶
DbUser
[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. 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.
ClusterIdentifier
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
AutoCreate
Create a database user with the name specified for the user named in
DbUser
if one does not exist.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.
CustomDomainName
The custom domain name for the cluster credentials.
Value¶
A list with the following syntax: