Interface CfnDataSource.RedshiftParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.RedshiftParametersProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
@Stability(Stable)
public static interface CfnDataSource.RedshiftParametersProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.quicksight.*; RedshiftParametersProperty redshiftParametersProperty = RedshiftParametersProperty.builder() .database("database") // the properties below are optional .clusterId("clusterId") .host("host") .iamParameters(RedshiftIAMParametersProperty.builder() .roleArn("roleArn") // the properties below are optional .autoCreateDatabaseUser(false) .databaseGroups(List.of("databaseGroups")) .databaseUser("databaseUser") .build()) .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder() .enableIdentityPropagation(false) .build()) .port(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.RedshiftParametersProperty
static final class
An implementation forCfnDataSource.RedshiftParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Cluster ID.Database.default String
getHost()
Host.default Object
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster.default Object
An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.default Number
getPort()
Port.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDatabase
Database.- See Also:
-
getClusterId
Cluster ID.This field can be blank if the
Host
andPort
are provided.- See Also:
-
getHost
Host.This field can be blank if
ClusterId
is provided.- See Also:
-
getIamParameters
An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster.This parameter can be used instead of DataSourceCredentials .
- See Also:
-
getIdentityCenterConfiguration
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.
- See Also:
-
getPort
Port.This field can be blank if the
ClusterId
is provided.Default: - 0
- See Also:
-
builder
-