Amazon Redshift Python 连接器的配置选项 - Amazon Redshift
access_key_idallow_db_user_overrideapp_nameauth_profileauto_createclient_idclient_secretcluster_identifiercredentials_providerdatabasedatabase_metadata_current_db_onlydb_groupsdb_userendpoint_urlgroup_federationhostIAMiam_disable_cacheidc_client_display_nameidc_regionidpPortidp_response_timeoutidp_tenantissuer_urllisten_portlogin_urlmax_prepared_statementsnumeric_to_floatpartner_sp_idpasswordportpreferred_roleprincipal_arn配置文件provider_name区域role_arnrole_session_name范围secret_access_key_idsession_tokenserverless_acct_idserverless_work_groupsslssl_insecuresslmodetimeouttokentoken_type用户web_identity_token
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

Amazon Redshift Python 连接器的配置选项

下面，您可以找到您可以为 Amazon Redshift Python 连接器指定的选项的说明。除非另有说明，否则以下选项适用于最新的可用连接器版本。

access_key_id

  • 默认值 – 无

  • 数据类型 – 字符串

为 IAM 数据库身份验证配置的 IAM 角色或用户的访问密钥 ID。

此参数为可选的。

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。有效值如下所示：

  • AdfsCredentialsProvider

  • AzureCredentialsProvider

  • BrowserAzureCredentialsProvider

  • BrowserAzureOAuth2CredentialsProvider

  • BrowserIdcAuthPlugin – 使用 Amazon IAM Identity Center 的授权插件。

  • BrowserSamlCredentialsProvider

  • IdpTokenAuthPlugin – 一种授权插件，可接受 Amazon IAM Identity Center 令牌，或者基于 OpenID Connect（OIDC）JSON 的身份令牌（JWT），该令牌由与 Amazon IAM Identity Center 关联的任意 Web 身份提供者提供。

  • PingCredentialsProvider

  • OktaCredentialsProvider

此参数为可选的。

database

  • 默认值 – 无

  • 数据类型 – 字符串

要连接到的数据库的名称。

此参数为必需参数。

database_metadata_current_db_only

  • 默认值 – True

  • 数据类型 – Boolean

一个值，指示应用程序是否支持多数据库数据共享目录。默认值 True 表示应用程序不支持多数据库数据共享目录以实现向后兼容性。

此参数为可选的。

db_groups

  • 默认值 – 无

  • 数据类型 – 字符串

DbUser 指示的用户为当前会话加入的现有数据库组名称的逗号分隔列表。

此参数为可选的。

db_user

  • 默认值 – 无

  • 数据类型 – 字符串

用于 Amazon Redshift 的用户 ID。

此参数为可选的。

endpoint_url

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon Redshift 端点 URL。此选项仅供 Amazon 内部使用。

此参数为可选的。

group_federation

  • 默认值 – False

  • 数据类型 – Boolean

此选项指定是否使用 Amazon Redshift IDP 组。

此参数为可选的。

true

使用 Amazon Redshift 身份提供者 (IDP) 组。

false

使用 STS API 和 GetClusterCredentials 进行用户联合身份验证，并指定用于连接的 db_groups。

host

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon Redshift 集群的主机名。

此参数为可选的。

IAM

  • 默认值 – False

  • 数据类型 – Boolean

IAM 身份验证已启用。

此参数为必需参数。

iam_disable_cache

  • 默认值 – False

  • 数据类型 – Boolean

此选项指定是否缓存 IAM 凭证。IAM 凭证将默认被缓存。当对 API 网关的请求受到限制时，这样可以提高性能。

此参数为可选的。

idc_client_display_name

  • 默认值 – Amazon Redshift Python 连接器

  • 数据类型 – 字符串

要用于使用 BrowserIdcAuthPlugin 的客户端的显示名称。

此参数为可选的。

idc_region

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon IAM Identity Center 实例所在的 Amazon 区域。

只有在 credentials_provider 配置选项中使用 BrowserIdcAuthPlugin 进行身份验证时，才需要此参数。

idpPort

  • 默认值 – 7890

  • 数据类型 – 整数

IdP 将 SAML 断言发送到的侦听端口。

此参数为必需参数。

idp_response_timeout

  • 默认值 – 120

  • 数据类型 – 整数

从 IdP 检索 SAML 断言的超时时间。

此参数为必需参数。

idp_tenant

  • 默认值 – 无

  • 数据类型 – 字符串

IdP 租户。

此参数为可选的。

issuer_url

  • 默认值 – 无

  • 数据类型 – 字符串

指向 Amazon IAM Identity Center 服务器的实例端点。

只有在 credentials_provider 配置选项中使用 BrowserIdcAuthPlugin 进行身份验证时，才需要此参数。

listen_port

  • 默认值 – 7890

  • 数据类型 – 整数

通过浏览器插件使用 SAML、Azure AD 或 Amazon IAM Identity Center 服务时，驱动程序用于接收来自身份提供者的 SAML 响应的端口。

此参数为可选的。

login_url

  • 默认值 – 无

  • 数据类型 – 字符串

IdP 的单点登录 Url。

此参数为可选的。

max_prepared_statements

  • 默认值：1000

  • 数据类型 – 整数

每个连接将缓存的最大预处理语句数。将该参数设置为 0 将禁用缓存机制。为此参数输入负数会将其设置为默认值。

此参数为可选的。

numeric_to_float

  • 默认值 – False

  • 数据类型 – Boolean

此选项指定连接器是否将数字数据类型值从 decimal.Decimal 转换为浮点数。默认情况下，连接器将数字数据类型值作为 decimal.Decimal 接收，而不会转换它们。

我们不建议为需要精确度的用例启用 numeric_to_float（数字转浮点），因为结果可能会四舍五入。

有关 decimal.Decimal 以及它与浮点数之间的权衡的更多信息，请参阅 Python 网站上的 decimal — 十进制定点和浮点算术。

此参数为可选的。

partner_sp_id

  • 默认值 – 无

  • 数据类型 – 字符串

用于 Ping 身份验证的合作伙伴 SP ID。

此参数为可选的。

password

  • 默认值 – 无

  • 数据类型 – 字符串

用于身份验证的密码。

此参数为可选的。

port

  • 默认值 – 5439

  • 数据类型 – 整数

Amazon Redshift 集群的端口号。

此参数为必需参数。

preferred_role

  • 默认值 – 无

  • 数据类型 – 字符串

当前连接首选的 IAM 角色。

此参数为可选的。

principal_arn

  • 默认值 – 无

  • 数据类型 – 字符串

要为其生成策略的用户或 IAM 角色的 Amazon 资源名称（ARN）。建议您将策略附加到角色，然后将该角色分配给用户以进行访问。

此参数为可选的。

配置文件

  • 默认值 – 无

  • 数据类型 – 字符串

包含 Amazon 凭据的 Amazon 凭据文件中的配置文件的名称。

此参数为可选的。

provider_name

  • 默认值 – 无

  • 数据类型 – 字符串

Redshift 本机验证提供程序的名称。

此参数为可选的。

区域

  • 默认值 – 无

  • 数据类型 – 字符串

集群所在的 Amazon Web Services 区域。

此参数为可选的。

role_arn

  • 默认值 – 无

  • 数据类型 – 字符串

调用方承担的角色的 Amazon 资源名称（ARN）。此参数由 JwtCredentialsProvider 指示的提供程序使用。

对于 JwtCredentialsProvider 提供商，此参数为必填项。否则，此参数位可选项。

role_session_name

  • 默认值 – jwt_redshift_session

  • 数据类型 – 字符串

所代入角色会话的标识符。通常，您可以传递与使用您的应用程序的用户关联的名称或标识符。您的应用程序使用的临时安全凭证与该用户相关联。此参数由 JwtCredentialsProvider 指示的提供程序使用。

此参数为可选的。

范围

  • 默认值 – 无

  • 数据类型 – 字符串

用户可以同意的范围列表，以空格分隔。您可以指定此参数，以便应用程序可以获得您想调用的 API 的同意。在为 credentials_provider 选项指定 BrowserAzureOAuth2CredentialsProvider 时，您可以指定此参数。

此参数是 BrowserAzureOAuth2CredentialsProvider 插件必需的。

secret_access_key_id

  • 默认值 – 无

  • 数据类型 – 字符串

为 IAM 数据库身份验证配置的 IAM 角色或用户的秘密访问密钥。

此参数为可选的。

session_token

  • 默认值 – 无

  • 数据类型 – 字符串

为 IAM 数据库身份验证配置的 IAM 角色或用户的访问密钥 ID。如果使用临时 Amazon 凭证，则需要此参数。

此参数为可选的。

serverless_acct_id

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon Redshift Serverless 账户 ID。

此参数为可选的。

serverless_work_group

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon Redshift Serverless 工作组名称。

此参数为可选的。

ssl

  • 默认值 – True

  • 数据类型 – Boolean

已启用安全套接字层（SSL）

此参数为必需参数。

ssl_insecure

  • 默认值 – False

  • 数据类型 – Boolean

指定是否禁用 IdP 主机的服务器 SSL 证书验证的值。将此参数设置为 True，将禁用对 IdP 主机的服务器 SSL 证书的验证。我们建议您在生产环境中保持默认值 False。

此参数为可选的。

sslmode

  • 默认值 – verify-ca

  • 数据类型 – 字符串

与 Amazon Redshift 的连接的安全性。您可以指定以下任一值：

  • verify-ca

  • verify-full

此参数为必需参数。

timeout

  • 默认值 – 无

  • 数据类型 – 整数

连接服务器时发生超时前等待的秒数。

此参数为可选的。

token

  • 默认值 – 无

  • 数据类型 – 字符串

Amazon IAM Identity Center 提供的访问令牌，或 OpenID Connect（OIDC）JSON Web 令牌（JWT，JSON Web Token），该令牌由与 Amazon IAM Identity Center 关联的 Web 身份提供者提供。您的应用程序必须通过 Amazon IAM Identity Center 或与 Amazon IAM Identity Center 关联的身份提供者，对您的应用程序用户进行身份验证，从而生成此令牌。

此参数可用于 IdpTokenAuthPlugin。

token_type

  • 默认值 – 无

  • 数据类型 – 字符串

IdpTokenAuthPlugin 中使用的令牌类型。

可以指定以下值：

ACCESS_TOKEN

如果您使用 Amazon IAM Identity Center 提供的访问令牌，请输入此项。

EXT_JWT

如果您使用 OpenID Connect（OIDC）JSON Web 令牌（JWT）（该令牌由与 Amazon IAM Identity Center 集成的基于 Web 的身份提供者提供），请输入此项。

此参数可用于 IdpTokenAuthPlugin。

用户

  • 默认值 – 无

  • 数据类型 – 字符串

用于身份验证的用户名。

此参数为可选的。

web_identity_token

  • 默认值 – 无

  • 数据类型 – 字符串

身份提供者提供的 OAuth 2.0 访问令牌或 OpenID Connect ID 令牌。通过使用 Web 身份提供者对使用您的应用程序的用户进行身份验证，确保您的应用程序获取此令牌。JwtCredentialsProvider 指示的提供商使用此参数。

对于 JwtCredentialsProvider 提供商，此参数为必填项。否则，此参数位可选项。