Skip to content

Get Cluster Credentials With Iam

redshift_get_cluster_credentials_with_iam R Documentation

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

Description

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.

Usage

redshift_get_cluster_credentials_with_iam(DbName, ClusterIdentifier,
  DurationSeconds, CustomDomainName)

Arguments

DbName

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.

ClusterIdentifier

The unique identifier of the cluster that contains the database for which you are requesting credentials.

DurationSeconds

The number of seconds until the returned temporary password expires.

Range: 900-3600. Default: 900.

CustomDomainName

The custom domain name for the IAM message cluster credentials.

Value

A list with the following syntax: 

list(
  DbUser = "string",
  DbPassword = "string",
  Expiration = as.POSIXct(
    "2015-01-01"
  ),
  NextRefreshTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_cluster_credentials_with_iam(
  DbName = "string",
  ClusterIdentifier = "string",
  DurationSeconds = 123,
  CustomDomainName = "string"
)