identity_center_auth_tokens
Creates, updates, deletes, gets or lists an identity_center_auth_tokens resource.
Overview
| Name | identity_center_auth_tokens |
| Type | Resource |
| Id | aws.redshift.identity_center_auth_tokens |
Fields
The following fields are returned by SELECT queries:
- get_identity_center_auth_token
| Name | Datatype | Description |
|---|---|---|
expiration_time | string | The time (UTC) when the token expires. After this timestamp, the token will no longer be valid for authentication. |
token | string | The encrypted authentication token containing the caller's Amazon Web Services IAM Identity Center identity information. This token is encrypted using Key Management Service and can only be decrypted by the specified Amazon Redshift clusters. Use this token with Amazon Redshift drivers to authenticate using your Amazon Web Services IAM Identity Center identity. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_identity_center_auth_token | select | ClusterIds, region | Generates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters. This API extracts the Amazon Web Services IAM Identity Center identity from enhanced credentials and creates a secure token that Amazon Redshift drivers can use for authentication. The token is encrypted using Key Management Service (KMS) and can only be decrypted by the specified Amazon Redshift clusters. The token contains the caller's Amazon Web Services IAM Identity Center identity information and is valid for a limited time period. This API is exclusively for use with Amazon Web Services IAM Identity Center enhanced credentials. If the caller is not using enhanced credentials with embedded Amazon Web Services IAM Identity Center identity, the API will return an error. |
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 |
|---|---|---|
ClusterIds | array | A list of cluster identifiers that the generated token can be used with. The token will be scoped to only allow authentication to the specified clusters. Constraints: ClusterIds must contain at least 1 cluster identifier. ClusterIds can hold a maximum of 20 cluster identifiers. Cluster identifiers must be 1 to 63 characters in length. The characters accepted for cluster identifiers are the following: Alphanumeric characters Hyphens Cluster identifiers must start with a letter. Cluster identifiers can't end with a hyphen or contain two consecutive hyphens. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_identity_center_auth_token
Generates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters. This API extracts the Amazon Web Services IAM Identity Center identity from enhanced credentials and creates a secure token that Amazon Redshift drivers can use for authentication. The token is encrypted using Key Management Service (KMS) and can only be decrypted by the specified Amazon Redshift clusters. The token contains the caller's Amazon Web Services IAM Identity Center identity information and is valid for a limited time period. This API is exclusively for use with Amazon Web Services IAM Identity Center enhanced credentials. If the caller is not using enhanced credentials with embedded Amazon Web Services IAM Identity Center identity, the API will return an error.
SELECT
expiration_time,
token
FROM aws.redshift.identity_center_auth_tokens
WHERE ClusterIds = '{{ ClusterIds }}' -- required
AND region = '{{ region }}' -- required
;