[ aws . redshift-serverless ]

get-credentials

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>

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-credentials
[--db-name <value>]
[--duration-seconds <value>]
--workgroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-name (string)

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

--duration-seconds (integer)

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

--workgroup-name (string)

The name of the workgroup associated with the database.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

dbPassword -> (string)

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

dbUser -> (string)

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.

expiration -> (timestamp)

The date and time the password in DbPassword expires.

nextRefreshTime -> (timestamp)

The date and time of when the DbUser and DbPassword authorization refreshes.