Skip to content

RedshiftParameters

Source code in docs_src/capo_quicksight/types/redshift_parameters.py
class RedshiftParameters(TypedDict, closed=True):
    host: NotRequired["capo_quicksight.types.host.Host"]
    """<p>Host. This field can be blank if <code>ClusterId</code> is provided.</p>"""
    port: "capo_quicksight.types.optional_port.OptionalPort"
    """<p>Port. This field can be blank if the <code>ClusterId</code> is provided.</p>"""
    database: "capo_quicksight.types.database.Database"
    """<p>Database.</p>"""
    cluster_id: NotRequired["capo_quicksight.types.cluster_id.ClusterId"]
    """<p>Cluster ID. This field can be blank if the <code>Host</code> and <code>Port</code> are provided.</p>"""
    iam_parameters: NotRequired[
        "capo_quicksight.types.redshift_iam_parameters.RedshiftIAMParameters"
    ]
    """<p>An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html">DataSourceCredentials</a>.</p>"""
    identity_center_configuration: NotRequired[
        "capo_quicksight.types.identity_center_configuration.IdentityCenterConfiguration"
    ]
    """<p>An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.</p> <p>This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.</p>"""

cluster_id instance-attribute

cluster_id: NotRequired[ClusterId]

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

database instance-attribute

database: Database

Database.

host instance-attribute

host: NotRequired[Host]

Host. This field can be blank if ClusterId is provided.

iam_parameters instance-attribute

iam_parameters: NotRequired[RedshiftIAMParameters]

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.

identity_center_configuration instance-attribute

identity_center_configuration: NotRequired[IdentityCenterConfiguration]

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 instance-attribute

Port. This field can be blank if the ClusterId is provided.