Skip to content

Get Credentials

redshiftserverless_get_credentials R Documentation

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless

Description

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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).

 <p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>

Usage

redshiftserverless_get_credentials(customDomainName, dbName,
  durationSeconds, workgroupName)

Arguments

customDomainName

The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.

dbName

The name of the database to get temporary authorization to log on to.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens.

  • Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The 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

durationSeconds

The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

workgroupName

The name of the workgroup associated with the database.

Value

A list with the following syntax: 

list(
  dbPassword = "string",
  dbUser = "string",
  expiration = as.POSIXct(
    "2015-01-01"
  ),
  nextRefreshTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_credentials(
  customDomainName = "string",
  dbName = "string",
  durationSeconds = 123,
  workgroupName = "string"
)