interface RedshiftIAMParametersProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDataSource.RedshiftIAMParametersProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_RedshiftIAMParametersProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnDataSource.RedshiftIAMParametersProperty |
 Python | aws_cdk.aws_quicksight.CfnDataSource.RedshiftIAMParametersProperty |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnDataSource » RedshiftIAMParametersProperty |
A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API.
For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const redshiftIAMParametersProperty: quicksight.CfnDataSource.RedshiftIAMParametersProperty = {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
};
Properties
| Name | Type | Description |
|---|---|---|
| role | string | Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. |
| auto | boolean | IResolvable | Automatically creates a database user. |
| database | string[] | A list of groups whose permissions will be granted to Quick Sight to access the cluster. |
| database | string | The user whose permissions and group memberships will be used by Quick Sight to access the cluster. |
roleArn
Type:
string
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster.
The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
autoCreateDatabaseUser?
Type:
boolean | IResolvable
(optional, default: false)
Automatically creates a database user.
If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
databaseGroups?
Type:
string[]
(optional)
A list of groups whose permissions will be granted to Quick Sight to access the cluster.
These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .
databaseUser?
Type:
string
(optional)
The user whose permissions and group memberships will be used by Quick Sight to access the cluster.
If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.