cluster_credentials_with_iams

Creates, updates, deletes, gets or lists a cluster_credentials_with_iams resource.

Overview

Name	cluster_credentials_with_iams
Type	Resource
Id	aws.redshift.cluster_credentials_with_iams

Fields

The following fields are returned by SELECT queries:

get_cluster_credentials_with_iam

Name	Datatype	Description
db_password	string	A temporary password that you provide when you connect to a database.
db_user	string	A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.
expiration	string	The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.
next_refresh_time	string	Reserved for future use.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cluster_credentials_with_iam	select	region	DbName, ClusterIdentifier, DurationSeconds, CustomDomainName	Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide. The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide.

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)
ClusterIdentifier	string	The unique identifier of the cluster that contains the database for which you are requesting credentials.
CustomDomainName	string	The custom domain name for the IAM message cluster credentials.
DbName	string	The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is allowed.
DurationSeconds	integer	The number of seconds until the returned temporary password expires. Range: 900-3600. Default: 900.

SELECT examples

get_cluster_credentials_with_iam

Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide. The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide.

SELECT
db_password,
db_user,
expiration,
next_refresh_time
FROM aws.redshift.cluster_credentials_with_iams
WHERE region = '{{ region }}' -- required
AND DbName = '{{ DbName }}'
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND DurationSeconds = '{{ DurationSeconds }}'
AND CustomDomainName = '{{ CustomDomainName }}'
;