Package software.amazon.awscdk.services.quicksight

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.RedshiftParametersProperty.Builder	A builder for CfnDataSource.RedshiftParametersProperty
static final class	CfnDataSource.RedshiftParametersProperty.Jsii$Proxy	An implementation for CfnDataSource.RedshiftParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.RedshiftParametersProperty.Builder	builder()
default String	getClusterId()	Cluster ID.
String	getDatabase()	Database.
default String	getHost()	Host.
default Object	getIamParameters()	An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.
default Object	getIdentityCenterConfiguration()	An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
default Number	getPort()	Port.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

Database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-database

getClusterId

@Stability(Stable)
@Nullable
default String getClusterId()

Cluster ID.

This field can be blank if the Host and Port are provided.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-clusterid

getHost

@Stability(Stable)
@Nullable
default String getHost()

Host.

This field can be blank if ClusterId is provided.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-host

getIamParameters

@Stability(Stable)
@Nullable
default Object getIamParameters()

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.

This parameter can be used instead of DataSourceCredentials .

Returns union: either IResolvable or CfnDataSource.RedshiftIAMParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-iamparameters

getIdentityCenterConfiguration

@Stability(Stable)
@Nullable
default Object getIdentityCenterConfiguration()

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.

Returns union: either IResolvable or CfnDataSource.IdentityCenterConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-identitycenterconfiguration

getPort

@Stability(Stable)
@Nullable
default Number getPort()

Port.

This field can be blank if the ClusterId is provided.

Default: - 0

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-port

builder

@Stability(Stable)
static CfnDataSource.RedshiftParametersProperty.Builder builder()

Returns:

a CfnDataSource.RedshiftParametersProperty.Builder of CfnDataSource.RedshiftParametersProperty