RedshiftIAMParameters
A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials
API. For more information on the redshift:GetClusterCredentials
API, see GetClusterCredentials
.
Contents
Note
In the following list, the required parameters are described first.
- RoleArn
-
Use the
RoleArn
structure to allow Amazon QuickSight to callredshift:GetClusterCredentials
on your cluster. The calling principal must haveiam:PassRole
access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- AutoCreateDatabaseUser
-
Automatically creates a database user. If your database doesn't have a
DatabaseUser
, set this parameter toTrue
. If there is noDatabaseUser
, Amazon QuickSight can't connect to your cluster. TheRoleArn
that you use for this operation must grant access toredshift:CreateClusterUser
to successfully create the user.Type: Boolean
Required: No
- DatabaseGroups
-
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the
DatabaseUser
. If you choose to include this parameter, theRoleArn
must grant access toredshift:JoinGroup
.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- DatabaseUser
-
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of
AutoCreateDatabaseUser
toTrue
to create a new user with PUBLIC permissions.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: