credentials
Creates, updates, deletes, gets or lists a credentials resource.
Overview
| Name | credentials |
| Type | Resource |
| Id | aws.redshift_serverless.credentials |
Fields
The following fields are returned by SELECT queries:
- get_credentials
| Name | Datatype | Description |
|---|---|---|
db_password | string | A temporary password that authorizes the user name returned by DbUser to log on to the database DbName. |
db_user | 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 | string (date-time) | The date and time the password in DbPassword expires. |
next_refresh_time | string (date-time) | The date and time of when the DbUser and DbPassword authorization refreshes. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_credentials | select | region | 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). 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. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_credentials
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). 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. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.
SELECT
db_password,
db_user,
expiration,
next_refresh_time
FROM aws.redshift_serverless.credentials
WHERE region = '{{ region }}' -- required
;