Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

GetClusterCredentials

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 AWS Identity and Access Management (IAM)user or role that executes 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 privilege.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ClusterIdentifier

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

Type: String

Required: Yes

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.

Type: String

Required: Yes

AutoCreate

Create a database user with the name specified for the user named in DbUser if one does not exist.

Type: Boolean

Required: No

DbGroups.DbGroup.N

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.

Type: Array of strings

Required: No

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.

Type: String

Required: No

DurationSeconds

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DbPassword

A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

Type: String

DbUser

A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

Type: String

Expiration

The date and time the password in DbPassword expires.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

UnsupportedOperation

The requested operation isn't supported.

HTTP Status Code: 400

Example

The following example shows a request to get cluster credentials.

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=GetClusterCredentials
   &ClusterIdentifier=examplecluster
   &DbUser=tempuser
   &DbName=exampledb
   &DurationSeconds=1800
&Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20160123/us-east-1/redshift/aws4_request
    &x-amz-date=20160123T000452Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<GetClusterCredentialsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <GetClusterCredentialsResults>
     <DBUsername>IAM:tempuser</DBUsername>
     <Expiration>2016-11-08T21:12:53Z</Expiration>       
     <DBPassword>EXAMPLEAbCdEf1234567890aBcDeFgHiJkLmNoPqRsTuVwXyZwXVPyJYBDm/gqX2Eeaq6P3==</DBPassword>
     </GetClusterCredentialsResult>
  <ResponseMetadata>
    <RequestId>fa337bb4-6a4d-11e2-a12a-cb8076a904bd</RequestId>
  </ResponseMetadata>
</GetClusterCredentialsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: