interface RedshiftParametersProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.QuickSight.CfnDataSource.RedshiftParametersProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_RedshiftParametersProperty |
Java | software.amazon.awscdk.services.quicksight.CfnDataSource.RedshiftParametersProperty |
Python | aws_cdk.aws_quicksight.CfnDataSource.RedshiftParametersProperty |
TypeScript | aws-cdk-lib » aws_quicksight » CfnDataSource » RedshiftParametersProperty |
The parameters for Amazon Redshift.
The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.
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 redshiftParametersProperty: quicksight.CfnDataSource.RedshiftParametersProperty = {
database: 'database',
// the properties below are optional
clusterId: 'clusterId',
host: 'host',
iamParameters: {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
},
identityCenterConfiguration: {
enableIdentityPropagation: false,
},
port: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| database | string | Database. |
| cluster | string | Cluster ID. |
| host? | string | Host. |
| iam | IResolvable | Redshift | An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. |
| identity | IResolvable | Identity | An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster. |
| port? | number | Port. |
database
Type:
string
Database.
clusterId?
Type:
string
(optional)
Cluster ID.
This field can be blank if the Host and Port are provided.
host?
Type:
string
(optional)
Host.
This field can be blank if ClusterId is provided.
iamParameters?
Type:
IResolvable | Redshift
(optional)
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.
This parameter can be used instead of DataSourceCredentials .
identityCenterConfiguration?
Type:
IResolvable | Identity
(optional)
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
port?
Type:
number
(optional, default: 0)
Port.
This field can be blank if the ClusterId is provided.

.NET
Go
Java
Python
TypeScript