Amazon Redshift Python 连接器的配置选项
下面，您可以找到您可以为 Amazon Redshift Python 连接器指定的选项的说明。
access_key_id
-
默认值 – 无
-
数据类型 – 字符串
为 IAM 数据库身份验证配置的 IAM 角色或 IAM 用户的访问密钥。
此参数为可选项。
allow_db_user_override
-
默认值 – False
-
数据类型 – Boolean
- True
指定连接器使用安全断言标记语言（SAML）断言中的
DbUser值。- False
指定使用
DbUser连接参数中的值。
此参数为可选项。
app_name
-
默认值 – 无
-
数据类型 – 字符串
用于身份验证的身份提供商（IdP）应用程序的名称。
此参数为可选项。
auth_profile
-
默认值 – 无
-
数据类型 – 字符串
连接属性为 JSON 的 Amazon Redshift 身份验证配置文件的名称。有关命名连接参数的更多信息，请参阅 RedshiftProperty 类。RedshiftProperty 类存储由最终用户提供的连接参数，如果适用，在 IAM 身份验证过程中生成（例如，临时 IAM 凭证）。有关更多信息，请参阅 RedshiftProperty 类
此参数为可选项。
auto_create
-
默认值 – False
-
数据类型 – Boolean
一个值，指示在用户不存在的情况下是否创建用户。
此参数为可选项。
client_id
-
默认值 – 无
-
数据类型 – 字符串
Azure IdP 中的客户端 ID。
此参数为可选项。
client_secret
-
默认值 – 无
-
数据类型 – 字符串
Azure IdP 中的客户端密钥。
此参数为可选项。
cluster_identifier
-
默认值 – 无
-
数据类型 – 字符串
Amazon Redshift 集群的集群标识符。
此参数为可选项。
credentials_provider
-
默认值 – 无
-
数据类型 – 字符串
对 Amazon Redshift 进行身份验证的 IdP。有效值如下所示：
OktaCredentialsProvider
AzureCredentialsProvider
BrowserAzureCredentialsProvider
PingCredentialsProvider
BrowserSamlCredentialsProvider
-
AdfsCredentialsProvider
此参数为可选项。
database
-
默认值 – 无
-
数据类型 – 字符串
要连接到的数据库的名称。
此参数为必需参数。
database_metadata_current_db_only
-
默认值 – True
-
数据类型 – Boolean
一个值，指示应用程序是否支持多数据库数据共享目录。默认值 True 表示应用程序不支持多数据库数据共享目录以实现向后兼容性。
此参数为可选项。
db_groups
-
默认值 – 无
-
数据类型 – 字符串
DbUser 指示的用户为当前会话加入的现有数据库组名称的逗号分隔列表。
此参数为可选项。
db_user
-
默认值 – 无
-
数据类型 – 字符串
用于 Amazon Redshift 的用户 ID。
此参数为可选项。
endpoint_url
-
默认值 – 无
-
数据类型 – 字符串
Amazon Redshift 终端节点 URL。此选项仅供 Amazon 内部使用。
此参数为必需参数。
host
-
默认值 – 无
-
数据类型 – 字符串
Amazon Redshift 集群的主机名。
此参数为必需参数。
iam
-
默认值 – False
-
数据类型 – Boolean
IAM 身份验证已启用。
此参数为必需参数。
iam_disable_cache
-
默认值 – False
-
数据类型 – Boolean
此选项指定是否缓存 IAM 凭证。IAM 凭证将默认被缓存。当对 API 网关的请求受到限制时，这样可以提高性能。
此参数为可选项。
idpPort
-
默认值 – 7890
-
数据类型 – 整数
IdP 将 SAML 断言发送到的侦听端口。
此参数为必需参数。
idp_response_timeout
-
默认值 – 120
-
数据类型 – 整数
从 IdP 检索 SAML 断言的超时时间。
此参数为必需参数。
idp_tenant
-
默认值 – 无
-
数据类型 – 字符串
IdP 租户。
此参数为可选项。
listen_port
-
默认值 – 7890
-
数据类型 – 整数
IdP 将 SAML 断言发送到的侦听端口。
此参数为可选项。
login_url
-
默认值 – 无
-
数据类型 – 字符串
IdP 的 SSO URL。
此参数为可选项。
max_prepared_statements
-
默认值：1000
-
数据类型 – 整数
可以同时打开的最大预处理语句数。
此参数为必需参数。
partner_sp_id
-
默认值 – 无
-
数据类型 – 字符串
用于 Ping 身份验证的合作伙伴 SP ID。
此参数为可选项。
password
-
默认值 – 无
-
数据类型 – 字符串
用于代理身份验证的密码。
此参数为必需参数。
port
-
默认值 – 5432
-
数据类型 – 整数
Amazon Redshift 集群的端口号。
此参数为必需参数。
preferred_role
-
默认值 – 无
-
数据类型 – 字符串
当前连接首选的 IAM 角色。
此参数为可选项。
principal_arn
-
默认值 – 无
-
数据类型 – 字符串
要为其生成策略的 IAM 用户或角色的 Amazon Resource Name（ARN）。
此参数为可选项。
profile
-
默认值 – 无
-
数据类型 – 字符串
包含 Amazon 凭据的 Amazon 凭据文件中的配置文件的名称。
此参数为可选项。
region
-
默认值 – 无
-
数据类型 – 字符串
集群所在的 Amazon Web Services 区域。
此参数为可选项。
role_arn
-
默认值 – 无
-
数据类型 – 字符串
调用方承担的角色的 Amazon Resource Name（ARN）。此参数由 JwtCredentialsProvider 指示的提供程序使用。
对于 JwtCredentialsProvider 提供商，此参数为必填项。否则，此参数位可选项。
role_session_name
-
默认值 – jwt_redshift_session
-
数据类型 – 字符串
所代入角色会话的标识符。通常，您可以传递与使用您的应用程序的用户关联的名称或标识符。您的应用程序使用的临时安全凭证与该用户相关联。此参数由 JwtCredentialsProvider 指示的提供程序使用。
此参数为可选项。
secret_access_key_id
-
默认值 – 无
-
数据类型 – 字符串
为 IAM 数据库身份验证配置的 IAM 角色或用户的秘密访问密钥。
此参数为可选项。
session_token
-
默认值 – 无
-
数据类型 – 字符串
为 IAM 数据库身份验证配置的 IAM 角色或用户的访问密钥 ID。如果使用临时 Amazon 凭证，则需要此参数。
此参数为可选项。
ssl
-
默认值 – True
-
数据类型 – Boolean
已启用安全套接字层（SSL）
此参数为必需参数。
ssl_insecure
-
默认值 – True
-
数据类型 – Boolean
一个值，指定是否验证 IdP 主机服务器证书。
此参数为可选项。
sslmode
-
默认值 – verify-ca
-
数据类型 – 字符串
与 Amazon Redshift 的连接的安全性。您可以指定以下任一值：
verify-ca
verify-full
此参数为必需参数。
user
-
默认值 – 无
-
数据类型 – 字符串
用于身份验证的用户名。
此参数为必需参数。
web_identity_token
-
默认值 – 无
-
数据类型 – 字符串
身份提供商提供的 OAuth 2.0 访问令牌或 OpenID Connect ID 令牌。通过使用 Web 身份提供商对使用您的应用程序的用户进行身份验证，确保您的应用程序获取此令牌。JwtCredentialsProvider 指示的提供商使用此参数。
对于 JwtCredentialsProvider 提供商，此参数为必填项。否则，此参数位可选项。