AWS::QuickSight::DataSource RedshiftParameters
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ClusterId" :
String
, "Database" :String
, "Host" :String
, "IAMParameters" :RedshiftIAMParameters
, "IdentityCenterConfiguration" :IdentityCenterConfiguration
, "Port" :Number
}
YAML
ClusterId:
String
Database:String
Host:String
IAMParameters:RedshiftIAMParameters
IdentityCenterConfiguration:IdentityCenterConfiguration
Port:Number
Properties
ClusterId
-
Cluster ID. This field can be blank if the
Host
andPort
are provided.Required: No
Type: String
Minimum:
1
Maximum:
64
Update requires: No interruption
Database
-
Database.
Required: Yes
Type: String
Minimum:
1
Maximum:
128
Update requires: No interruption
Host
-
Host. This field can be blank if
ClusterId
is provided.Required: No
Type: String
Minimum:
1
Maximum:
256
Update requires: No interruption
IAMParameters
-
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
Required: No
Type: RedshiftIAMParameters
Update requires: No interruption
IdentityCenterConfiguration
-
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.
This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
Required: No
Type: IdentityCenterConfiguration
Update requires: No interruption
Port
-
Port. This field can be blank if the
ClusterId
is provided.Required: No
Type: Number
Minimum:
0
Maximum:
65535
Update requires: No interruption