# 身份验证连接参数
<a name="jdbc-v3-driver-authentication-connection-parameters"></a>

Athena JDBC 3.x 驱动程序支持多种身份验证方法。所需的连接参数取决于您所使用的身份验证方法。

**Topics**
+ [IAM](jdbc-v3-driver-iam-credentials.md)
+ [默认](jdbc-v3-driver-default-credentials.md)
+ [AWS 配置文件](jdbc-v3-driver-aws-configuration-profile-credentials.md)
+ [实例配置文件](jdbc-v3-driver-instance-profile-credentials.md)
+ [自定义](jdbc-v3-driver-custom-credentials.md)
+ [JWT](jdbc-v3-driver-jwt-credentials.md)
+ [JWT 可信身份传播](jdbc-v3-driver-jwt-tip-credentials.md)
+ [浏览器可信身份传播](jdbc-v3-driver-browser-oidc-tip-credentials.md)
+ [Azure AD](jdbc-v3-driver-azure-ad-credentials.md)
+ [Okta](jdbc-v3-driver-okta-credentials.md)
+ [Ping](jdbc-v3-driver-ping-credentials.md)
+ [AD FS](jdbc-v3-driver-adfs-credentials.md)
+ [浏览器 Azure AD](jdbc-v3-driver-browser-azure-ad-credentials.md)
+ [浏览器 SAML](jdbc-v3-driver-browser-saml-credentials.md)
+ [DataZone IdC](jdbc-v3-driver-datazone-idc.md)
+ [DataZone IAM](jdbc-v3-driver-datazone-iamcp.md)

# IAM 凭证
<a name="jdbc-v3-driver-iam-credentials"></a>

您可以通过设置以下连接参数，使用自己的 IAM 凭证与 JDBC 驱动程序连接到 Amazon Athena。

## 用户
<a name="jdbc-v3-driver-user"></a>

您的 AWS 访问密钥 ID。有关访问密钥的信息，请参阅《IAM 用户指南》**中的 [AWS 安全凭证](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | AccessKeyId | 必需 | none | 

## 密码
<a name="jdbc-v3-driver-password"></a>

您的 AWS 密钥 ID。有关访问密钥的信息，请参阅《IAM 用户指南》**中的 [AWS 安全凭证](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | SecretAccessKey | 可选 | none | 

## 会话令牌
<a name="jdbc-v3-driver-session-token"></a>

如果您使用的是临时 AWS 凭证，则必须指定会话令牌。有关临时凭证的更多信息，请参阅《*IAM 用户指南*》中的 [IAM 临时安全凭证](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| SessionToken | none | 可选 | none | 

# 默认凭证
<a name="jdbc-v3-driver-default-credentials"></a>

您可以通过设置以下连接参数，使用在客户端系统上配置的默认凭证来连接 Amazon Athena。有关使用默认凭证的信息，请参阅《适用于 Java 的 AWS SDK 开发人员指南》**中的[使用默认凭证提供程序链](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default)。

## 凭证提供程序
<a name="jdbc-v3-driver-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `DefaultChain`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | DefaultChain | 

# AWS 配置文件凭证
<a name="jdbc-v3-driver-aws-configuration-profile-credentials"></a>

您可以通过设置以下连接参数来使用存储在 AWS 配置文件中的凭证。AWS 配置文件通常存储在 `~/.aws` 目录的文件中。有关 AWS 配置文件的信息，请参阅《适用于 Java 的 AWS SDK Developer Guide》**中的 [Use profiles](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials-profiles.html)。

## 凭证提供程序
<a name="jdbc-v3-driver-aws-configuration-profile-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `ProfileCredentials`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | ProfileCredentials | 

## 配置文件名称
<a name="jdbc-v3-driver-profile-name"></a>

AWS 配置文件的名称，其凭证应该用于对 Athena 的请求进行身份验证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| ProfileName | none | 必需 | none | 

**注意**  
您也可以将配置文件名称指定为 `CredentialsProviderArguments` 参数的值，虽然这种用法已被弃用。

# 实例配置文件凭证
<a name="jdbc-v3-driver-instance-profile-credentials"></a>

此身份验证类型用于 Amazon EC2 实例。*实例配置文件*是附加到 Amazon EC2 实例的配置文件。使用实例配置文件凭证提供程序，将 AWS 凭证的管理委托给 Amazon EC2 实例元数据服务。如此，开发人员就无需在 Amazon EC2 实例上永久存储凭证，也不必担心轮换或管理临时凭证了。

## 凭证提供程序
<a name="jdbc-v3-driver-instance-profile-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `InstanceProfile`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | InstanceProfile | 

# 自定义凭证
<a name="jdbc-v3-driver-custom-credentials"></a>

您可以使用这种身份验证类型，通过使用实现 [AwsCredentialsProvider](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html) 接口的 Java 类来提供自己的凭证。

## 凭证提供程序
<a name="jdbc-v3-driver-custom-credentials-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为实现 [AwsCredentialsProvider](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/AwsCredentialsProvider.html) 接口的自定义类的完全限定类名。处于运行时系统中时，这个类必须位于使用 JDBC 驱动程序的应用程序的 Java 类路径上。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | AwsCredentialsProvider 的自定义实现的完全限定类名 | 

## 凭证提供程序参数
<a name="jdbc-v3-driver-credentials-provider-arguments"></a>

自定义凭证提供程序构造函数的字符串参数的逗号分隔列表。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| CredentialsProviderArguments | AwsCredentialsProviderArguments（已弃用） | 可选 | none | 

# JWT 凭证
<a name="jdbc-v3-driver-jwt-credentials"></a>

凭借此身份验证类型，您可以使用从外部身份提供者处获得的 JSON Web 令牌（JWT）作为连接参数，对 Athena 进行身份验证。外部凭证提供程序必须已经与 AWS 联合。

## 凭证提供程序
<a name="jdbc-v3-driver-jwt-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `JWT`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | JWT | 

## JWT Web 身份令牌
<a name="jdbc-v3-driver-jwt-web-identity-token"></a>

从外部联合身份提供者处获得的 JWT 令牌。此令牌将用于向 Athena 进行身份验证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtWebIdentityToken | web\$1identity\$1token（已弃用） | 必需 | none | 

## JWT 角色 ARN
<a name="jdbc-v3-driver-jwt-role-arn"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关代入角色的信息，请参阅《AWS Security Token Service API Reference》**中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtRoleArn | role\$1arn（已弃用） | 必需 | none | 

## JWT 角色会话名称
<a name="jdbc-v3-driver-jwt-role-session-name"></a>

使用 JWT 凭证进行身份验证时的会话名称。此名称可以是您选择的任何名称。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtRoleSessionName | role\$1session\$1name（已弃用） | 必需 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-jwt-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

# JWT 与身份中心集成
<a name="jdbc-v3-driver-jwt-tip-credentials"></a>

通过此身份验证类型，您可以使用从外部身份提供者处获得的 JSON Web 令牌（JWT）作为连接参数，在 Athena 进行身份验证。您可以使用此插件，通过可信身份传播，实现对企业身份的支持。有关如何将可信身份传播与驱动程序结合使用的更多信息，请参阅[将可信身份传播与 Amazon Athena 驱动程序结合使用](using-trusted-identity-propagation.md)。您还可以[使用 CloudFormation 配置和部署资源](using-trusted-identity-propagation-cloudformation.md)。

使用可信身份传播，可以向 IAM 角色添加身份上下文，以识别请求访问 AWS 资源的用户身份。有关启用和使用可信身份传播的信息，请参阅 [What is trusted identity propagation?](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation.html)。

## 凭证提供程序
<a name="jdbc-v3-driver-jwt-tip-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `JWT_TIP`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | JWT\$1TIP | 

## JWT Web 身份令牌
<a name="jdbc-v3-driver-jwt-tip-web-identity-token"></a>

从外部联合身份提供者处获得的 JWT 令牌。此令牌将用于向 Athena 进行身份验证。令牌缓存默认为启用，以允许在驱动程序连接之间使用相同的 Identity Center 访问令牌。建议在“测试连接”时提供新的 JWT 令牌，因为交换的令牌仅在驱动程序实例处于活动状态期间才存在。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtWebIdentityToken | web\$1identity\$1token（已弃用） | 必需 | none | 

## WorkgroupArn
<a name="jdbc-v3-driver-jwt-tip-workgroup-arn"></a>

Amazon Athena 工作组的 Amazon 资源名称（ARN）。有关工作组的更多信息，请参阅 [WorkGroup](https://docs.aws.amazon.com/athena/latest/APIReference/API_WorkGroup.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| WorkGroupArn | none | 必需 | 主 | 

## JWT 应用程序角色 ARN
<a name="jdbc-v3-driver-jwt-tip-application-role-arn"></a>

要代入的角色的 ARN。此角色用于 JWT 交换、通过工作组标签获取 IAM Identity Center 客户管理的应用程序 ARN，以及获取访问角色 ARN。有关代入角色的信息，请参阅 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| ApplicationRoleArn | none | 必需 | none | 

## JWT 角色会话名称
<a name="jdbc-v3-driver-jwt-tip-role-session-name"></a>

使用 JWT 凭证进行身份验证时的会话名称。它可以是您选择的任何名称。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtRoleSessionName | role\$1session\$1name（已弃用） | 必需 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-jwt-tip-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 [AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## JWT 访问角色 ARN
<a name="jdbc-v3-driver-jwt-tip-access-role-arn"></a>

要代入的角色的 ARN。这是 Athena 服务代表您进行调用时代入的角色。有关代入角色的更多信息，请参阅 *AWS Security Token Service API Reference* 中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AccessRoleArn | none | 可选 | none | 

## IAM Identity Center 客户管理的应用程序 ARN
<a name="jdbc-v3-driver-jwt-tip-customer-idc-application-arn"></a>

IAM Identity Center 客户管理的应用程序 ARN。有关更多信息，请参阅 [Customer Managed Application](https://docs.aws.amazon.com/singlesignon/latest/userguide/customermanagedapps.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| CustomerIdcApplicationArn | none | 可选 | none | 

# 基于浏览器的身份中心集成
<a name="jdbc-v3-driver-browser-oidc-tip-credentials"></a>

通过此身份验证类型，您可以从外部身份提供者处获取新的 JSON Web 令牌（JWT），并使用 Athena 进行身份验证。您可以使用此插件，通过可信身份传播，实现对企业身份的支持。有关如何将可信身份传播与驱动程序结合使用的更多信息，请参阅[将可信身份传播与 Amazon Athena 驱动程序结合使用](using-trusted-identity-propagation.md)。您还可以[使用 CloudFormation 配置和部署资源](using-trusted-identity-propagation-cloudformation.md)。

使用可信身份传播，可以向 IAM 角色添加身份上下文，以识别请求访问 AWS 资源的用户身份。有关启用和使用可信身份传播的信息，请参阅 [What is trusted identity propagation?](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation.html)。

**注意**  
该插件专为单用户桌面环境而设计。在 Windows Server 等共享环境中，系统管理员负责建立和维护用户之间的安全边界。

## 凭证提供程序
<a name="jdbc-v3-driver-browser-oidc-tip-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `BrowserOidcTip`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | BrowserOidcTip | 

## Idp 公开配置 URL
<a name="jdbc-v3-driver-browser-oidc-tip-idp-well-known-config"></a>

IDP 公开配置 URL 是为身份提供者提供 OpenID Connect 配置详细信息的端点。此 URL 通常以 `.well-known/openid-configuration` 结尾，并包含有关身份验证端点、支持的功能和令牌签名密钥的基本元数据。例如，如果您使用的是 *Okta*，则 URL 可能类似 `https://your-domain.okta.com/.well-known/openid-configuration`。

故障排除：如果您收到连接错误，请验证是否可以从您的网络访问此 URL 并返回有效的 *OpenID Connect* 配置 JSON。该 URL 必须能够已安装驱动程序的客户端访问，并且应由您的身份提供者管理员提供。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpWellKnownConfigurationUrl | none | 必需 | none | 

## 客户端标识符
<a name="jdbc-v3-driver-browser-oidc-tip-client-id"></a>

OpenID Connect 提供商向应用程序颁发的客户端标识符。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OidcClientId | none | 必需 | none | 

## WorkgroupArn
<a name="jdbc-v3-driver-browser-oidc-tip-workgroup-arn"></a>

包含可信身份传播配置标签的 Amazon Athena 工作组的 Amazon 资源名称（ARN）。有关工作组的更多信息，请参阅 [WorkGroup](https://docs.aws.amazon.com/athena/latest/APIReference/API_WorkGroup.html)。

**注意**  
此参数与指定查询运行位置的 `Workgroup` 参数不同。必须同时设置两个参数：  
`WorkgroupArn`：指向包含可信身份传播配置标签的工作组
`Workgroup`：指定将在其中执行查询的工作组
虽然这两个参数通常指向同一个工作组，但必须显式设置两个参数以确保正常运行。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| WorkGroupArn | none | 必需 | 主 | 

## JWT 应用程序角色 ARN
<a name="jdbc-v3-driver-browser-oidc-tip-application-role-arn"></a>

JWT 交换时将代入角色的 ARN。此角色用于 JWT 交换、通过工作组标签获取 IAM Identity Center 客户管理的应用程序 ARN，以及获取访问角色 ARN。有关代入角色的信息，请参阅 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| ApplicationRoleArn | none | 必需 | none | 

## JWT 角色会话名称
<a name="jdbc-v3-driver-browser-oidc-tip-role-session-name"></a>

IAM 会话的名称。它可以是任意名称，但通常，人们会填写与使用自身应用程序的用户关联的名称或标识符。这样，您的应用程序使用的临时安全凭证会与该用户相关联。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| JwtRoleSessionName | role\$1session\$1name（已弃用） | 必需 | none | 

## 客户端密钥
<a name="jdbc-v3-driver-browser-oidc-tip-client-secret"></a>

clientSecret 是您的身份提供者颁发的机密密钥，用于对您的应用程序（客户端）进行身份验证。虽然此参数是可选的，可能并非所有身份验证流程必需，但其使用可提了额外的安全层。如果您的 IDP 配置需要客户端密钥，则必须将此参数与身份提供者管理员提供的值一起包括在内。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OidcClientSecret | none | 可选 | none | 

## 范围
<a name="jdbc-v3-driver-browser-oidc-tip-scope"></a>

该范围指定您的应用程序向身份提供者请求的访问级别。要接收包含基本用户身份声明的 ID 令牌，您必须在范围内包含 `openid`。您的范围可能需要包括 `email` 或 `profile` 等其他权限，具体取决于您的身份提供者（例如 *Microsoft Entra ID*）配置为包含在 ID 令牌中的用户声明。这些声明对于正确的*可信身份传播*映射至关重要。如果用户身份映射失败，请验证您的范围是否包含所有必需的权限，并且您的身份提供者已配置为在 ID 令牌中包含所需的声明。这些声明必须与 IAM Identity Center 中的*可信令牌发布者*映射配置相匹配。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 范围 | none | 可选 | openid email offline\$1access | 

## 角色会话持续时间
<a name="jdbc-v3-driver-browser-oidc-tip-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 [AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## JWT 访问角色 ARN
<a name="jdbc-v3-driver-browser-oidc-tip-access-role-arn"></a>

Athena 代表您进行调用时所代入角色的 ARN。有关代入角色的更多信息，请参阅 *AWS Security Token Service API Reference* 中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AccessRoleArn | none | 可选 | none | 

## IAM Identity Center 客户管理的应用程序 ARN
<a name="jdbc-v3-driver-browser-oidc-tip-customer-idc-application-arn"></a>

IAM Identity Center 客户管理的应用程序 ARN。有关更多信息，请参阅 [Customer Managed Application](https://docs.aws.amazon.com/singlesignon/latest/userguide/customermanagedapps.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| CustomerIdcApplicationArn | none | 可选 | none | 

## 身份提供者端口号
<a name="jdbc-v3-driver-browser-oidc-tip-idp-port-number"></a>

用于 OAuth 2.0 回调服务器的本地端口号。此项用作 redirect\$1uri，您需要在 IDP 应用程序中将其列入允许列表。默认生成的 redirect\$1uri 为：http://localhost:7890/athena

**警告**  
在 Windows 终端服务器或远程桌面服务等共享环境中，环回端口（默认值：7890）在同一台计算机上的所有用户之间共享。系统管理员可通过以下方式降低潜在的端口劫持风险：  
为不同用户组配置不同的端口号
使用 Windows 安全策略限制端口访问权限
在用户会话之间实现网络隔离
如果无法实现这些安全控制措施，我们建议改用 [JWT 可信身份传播](jdbc-v3-driver-jwt-tip-credentials.md)插件，该插件不需要环回端口。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpPortNumber | none | 可选 | 7890 | 

## 身份提供者响应超时
<a name="jdbc-v3-driver-browser-oidc-tip-idp-response-timeout"></a>

等待 OAuth 2.0 回调响应的超时时间（秒）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpResponseTimeout | none | 可选 | 120 | 

## 启用令牌缓存
<a name="jdbc-v3-driver-browser-oidc-tip-enable-token-caching"></a>

EnableTokenCaching 参数决定驱动程序是否在两次连接之间缓存身份验证令牌。将 EnableTokenCaching 设置为 true 可减少身份验证提示并改善用户体验，但应谨慎使用。此设置最适合单用户桌面环境。在 Windows Server 等共享环境中，建议禁用此项，以防止连接字符串相似的用户之间可能共享令牌。

对于使用 Tableau Server 等工具的企业部署，我们建议使用 [JWT 可信身份传播](jdbc-v3-driver-jwt-tip-credentials.md)插件，而不是这种身份验证方法。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| EnableTokenCaching | none | 可选 | FALSE | 

# Azure AD 凭证
<a name="jdbc-v3-driver-azure-ad-credentials"></a>

这是一种基于 SAML 的身份验证机制，允许使用 Azure AD 身份提供者对 Athena 进行身份验证。此方法假设 Athena 和 Azure AD 之间已经建立了联合身份验证。

**注意**  
本节中的某些参数名称具有别名。这些别名在功能上等同于参数名称，提供这些别名的目的是与 JDBC 2.x 驱动程序向后兼容。由于参数名称经过改进以遵循更清晰、更一致的命名约定，因此建议使用这些名称而不是已经弃用的别名。

## 凭证提供程序
<a name="jdbc-v3-driver-azure-ad-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `AzureAD`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | AzureAD | 

## 用户
<a name="jdbc-v3-driver-azure-ad-user"></a>

将用于对 Azure AD 进行身份验证的 Azure AD 用户的电子邮件地址。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | UID（已弃用） | 必需 | none | 

## 密码
<a name="jdbc-v3-driver-azure-ad-password"></a>

Azure AD 用户的密码。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | PWD（已弃用） | 必需 | none | 

## Azure AD 租户 ID
<a name="jdbc-v3-driver-azure-ad-tenant-id"></a>

Azure AD 应用程序的租户 ID。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AzureAdTenantId | tenant\$1id（已弃用） | 必需 | none | 

## Azure AD 客户端 ID
<a name="jdbc-v3-driver-azure-ad-client-id"></a>

Azure AD 应用程序的客户端 ID。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AzureAdClientId | client\$1id（已弃用） | 必需 | none | 

## Azure AD 客户端密钥
<a name="jdbc-v3-driver-azure-ad-client-secret"></a>

Azure AD 应用程序的客户端密钥。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AzureAdClientSecret | client\$1secret（已弃用） | 必需 | none | 

## Preferred role
<a name="jdbc-v3-driver-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-lake-formation-enabled"></a>

指定是否使用 [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS API 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# Okta 凭证
<a name="jdbc-v3-driver-okta-credentials"></a>

这是一种基于 SAML 的身份验证机制，允许使用 Okta 身份提供者对 Athena 进行身份验证。此方法假设 Athena 和 Okta 之间已经建立了联合身份验证。

## 凭证提供程序
<a name="jdbc-v3-driver-okta-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `Okta`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | Okta | 

## 用户
<a name="jdbc-v3-driver-okta-user"></a>

将用于对 Okta 进行身份验证的 Okta 用户的电子邮件地址。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | UID（已弃用） | 必需 | none | 

## 密码
<a name="jdbc-v3-driver-okta-password"></a>

Okta 用户的密码。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | PWD（已弃用） | 必需 | none | 

## Okta 主机名称
<a name="jdbc-v3-driver-okta-host-name"></a>

您的 Okta 组织的 URL。您可以从 Okta 应用程序中的**嵌入链接** URL 中提取 `idp_host` 参数。要查看步骤，请参阅[从 Okta 检索 ODBC 配置信息](odbc-okta-plugin.md#odbc-okta-plugin-retrieve-odbc-configuration-information-from-okta)。从 `https://` 之后的第一个分段一直到 `okta.com`（包括在内）都是您的 IdP 主机（例如：以 `https://trial-1234567.okta.com` 开头的 URL 的 `trial-1234567.okta.com`）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OktaHostName | IdP\$1Host（已弃用） | 必需 | none | 

## Okta 应用程序 ID
<a name="jdbc-v3-driver-okta-application-id"></a>

适用于您的应用程序的两部分标识符。您可以从 Okta 应用程序的**嵌入链接** URL 中提取应用程序 ID。要查看步骤，请参阅[从 Okta 检索 ODBC 配置信息](odbc-okta-plugin.md#odbc-okta-plugin-retrieve-odbc-configuration-information-from-okta)。应用程序 ID 是 URL 的最后两个分段，包括中间的正斜杠。这两个分段是两个长度为 20 个字符的字符串，其中包含数字和大小写字母（例如 `Abc1de2fghi3J45kL678/abc1defghij2klmNo3p4`）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OktaAppId | App\$1ID（已弃用） | 必需 | none | 

## Okta 应用程序名称
<a name="jdbc-v3-driver-okta-application-name"></a>

Okta 应用程序的名称。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OktaAppName | App\$1Name（已弃用） | 必需 | none | 

## Okta MFA 类型
<a name="jdbc-v3-driver-okta-mfa-type"></a>

如果您已将 Okta 设置为要求多重身份验证（MFA），则需要根据要使用的第二个因素指定 Okta MFA 类型和其他参数。

Okta MFA 类型是用于向 Okta 进行身份验证的第二种身份验证因素类型（仅次于密码）。受支持的第二个因素包括通过 Okta Verify 应用程序传送的推送通知，以及由 Okta Verify、Google Authenticator 生成或通过 SMS 发送的临时一次性密码（TOTP）。各个组织的安全策略决定用户登录是否需要 MFA。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 可能的值 | 
| --- | --- | --- | --- | --- | 
| OktaMfaType | okta\$1mfa\$1type（已弃用） | 如果将 Okta 设置为需要 MFA，则为必填项 | none | oktaverifywithpush, oktaverifywithtotp, googleauthenticator, smsauthentication | 

## Okta 电话号码
<a name="jdbc-v3-driver-okta-phone-number"></a>

选择 `smsauthentication` MFA 类型时，Okta 将使用 SMS 向其发送临时一次性密码的电话号码。该电话号码必须是美国或加拿大电话号码。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OktaPhoneNumber | okta\$1phone\$1number（已弃用） | 如果 OktaMfaType 是 smsauthentication，则为必填项 | none | 

## Okta MFA 等待时间
<a name="jdbc-v3-driver-okta-mfa-wait-time"></a>

在驱动程序引发超时异常之前，等待用户确认来自 Okta 的推送通知的时长（以秒为单位）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| OktaMfaWaitTime | okta\$1mfa\$1wait\$1time（已弃用） | 可选 | 60 | 

## Preferred role
<a name="jdbc-v3-driver-okta-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-role-okta-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-okta-lake-formation-enabled"></a>

指定是否使用 [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS API 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# Ping 凭证
<a name="jdbc-v3-driver-ping-credentials"></a>

这是一种基于 SAML 的身份验证机制，允许使用 Ping Federate 身份提供者对 Athena 进行身份验证。此方法假设 Athena 和 Ping Federate 之间已经建立了联合身份验证。

## 凭证提供程序
<a name="jdbc-v3-driver-ping-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `Ping`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | Ping | 

## 用户
<a name="jdbc-v3-driver-ping-user"></a>

Ping Federate 用户用于通过 Ping Federate 进行身份验证的电子邮件地址。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | UID（已弃用） | 必需 | none | 

## 密码
<a name="jdbc-v3-driver-ping-password"></a>

Ping Federate 用户的密码。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | PWD（已弃用） | 必需 | none | 

## PingHostName
<a name="jdbc-v3-driver-ping-host-name"></a>

您的 Ping 服务器的地址。要查找您的地址，请访问以下 URL 并查看 **SSO 应用程序端点**字段。

```
https://your-pf-host-#:9999/pingfederate/your-pf-app#/spConnections
```


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PingHostName | IdP\$1Host（已弃用） | 必需 | none | 

## PingPortNumber
<a name="jdbc-v3-driver-ping-port-number"></a>

用于连接 IdP 主机的端口号。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PingPortNumber | IdP\$1Port（已弃用） | 必需 | none | 

## PingPartnerSpId
<a name="jdbc-v3-driver-ping-partner-spid"></a>

服务提供商地址。要查找服务提供商地址，请访问以下 URL 并查看 **SSO 应用程序端点**字段。

```
https://your-pf-host-#:9999/pingfederate/your-pf-app#/spConnections
```


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
|  PingPartnerSpId  | Partner\$1SPID（已弃用） | 必需 | none | 

## Preferred role
<a name="jdbc-v3-driver-ping-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-role-ping-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-ping-lake-formation-enabled"></a>

指定是否使用 [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS API 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# AD FS 凭证
<a name="jdbc-v3-driver-adfs-credentials"></a>

这是一种基于 SAML 的身份验证机制，允许使用 Microsoft Active Directory 联合身份验证服务（AD FS）对 Athena 进行身份验证。此方法假设用户已在 Athena 和 AD FS 之间建立了联合身份验证。

## 凭证提供程序
<a name="jdbc-v3-driver-adfs-credentials-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `ADFS`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | ADFS | 

## 用户
<a name="jdbc-v3-driver-adfs-credentials-user"></a>

AD FS 用户的电子邮件地址，用于对 AD FS 进行身份验证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | UID（已弃用） | 基于表单的身份验证的必要项。Windows 集成式身份验证的可选项。 | none | 

## 密码
<a name="jdbc-v3-driver-adfs-credentials-password"></a>

AD FS 用户的密码。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | PWD（已弃用） | 基于表单的身份验证的必要项。Windows 集成式身份验证的可选项。 | none | 

## ADFS 主机名
<a name="jdbc-v3-driver-adfs-credentials-adfshostname"></a>

AD FS 服务器的地址。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AdfsHostName | IdP\$1Host（已弃用） | 必需 | none | 

## ADFS 端口号
<a name="jdbc-v3-driver-adfs-credentials-adfsportnumber"></a>

用于连接 AD FS 服务器的端口号。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AdfsPortNumber | IdP\$1Port（已弃用） | 必需 | none | 

## ADFS 依赖方
<a name="jdbc-v3-driver-adfs-credentials-adfsrelyingparty"></a>

受信任的依赖方。使用此参数覆盖 AD FS 依赖方端点 URL。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AdfsRelyingParty | LoginToRP（已弃用） | 可选 | urn:amazon:webservices | 

## 已启用 ADFS WIA
<a name="jdbc-v3-driver-adfs-credentials-adfswiaenabled"></a>

布尔值。使用此参数可通过 AD FS 启用 Windows 集成式身份验证（WIA）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AdfsWiaEnabled | none | 可选 | FALSE | 

## Preferred role
<a name="jdbc-v3-driver-adfs-credentials-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅《AWS Security Token Service API Reference》**中的 [https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-adfs-credentials-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅《AWS Security Token Service API Reference》**中的 [https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-adfs-credentials-lake-formation-enabled"></a>

指定是否使用 [https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# 浏览器 Azure AD 凭证
<a name="jdbc-v3-driver-browser-azure-ad-credentials"></a>

浏览器 Azure AD 是一个基于 SAML 的身份验证机制，可与 Azure AD 身份提供者配合使用并支持多重身份验证。与标准 Azure AD 身份验证机制不同，该机制不需要在连接参数中输入用户名、密码或客户端密钥。与标准 Azure AD 身份验证机制一样，浏览器 Azure AD 还假设用户已经在 Athena 和 Azure AD 之间建立了联合身份验证。

## 凭证提供程序
<a name="jdbc-v3-driver-browser-azure-ad-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `BrowserAzureAD`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | BrowserAzureAD | 

## Azure AD 租户 ID
<a name="jdbc-v3-driver-browser-azure-ad-azure-ad-tenant-id"></a>

Azure AD 应用程序的租户 ID


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AzureAdTenantId | tenant\$1id（已弃用） | 必需 | none | 

## Azure AD 客户端 ID
<a name="jdbc-v3-driver-browser-azure-ad-azure-ad-client-id"></a>

Azure AD 应用程序的客户端 ID


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| AzureAdClientId | client\$1id（已弃用） | 必需 | none | 

## 身份提供者响应超时
<a name="jdbc-v3-driver-identity-provider-response-timeout"></a>

驱动程序停止等待 Azure AD 发出 SAML 响应之前的时长（以秒为单位）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpResponseTimeout | idp\$1response\$1timeout（已弃用） | 可选 | 120 | 

## Preferred role
<a name="jdbc-v3-driver-browser-azure-ad-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-browser-azure-ad-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-browser-azure-ad-lake-formation-enabled"></a>

指定是否使用 [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS API 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# 浏览器 SAML 凭证
<a name="jdbc-v3-driver-browser-saml-credentials"></a>

浏览器 SAML 是一个通用身份验证插件，可与基于 SAML 的身份提供者配合使用并支持多重身份验证。

## 凭证提供程序
<a name="jdbc-v3-driver-browser-saml-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `BrowserSaml`。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | BrowserSaml | 

## 单点登录的登录 URL
<a name="jdbc-v3-driver-single-sign-on-login-url"></a>

应用程序在基于 SAML 的身份提供者上的单点登录 URL。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| SsoLoginUrl | login\$1url（已弃用） | 必需 | none | 

## 侦听端口
<a name="jdbc-v3-driver-listen-port"></a>

用于侦听 SAML 响应的端口号。此值应与配置基于 SAML 的身份提供者时所用的 URL 相匹配（例如：`http://localhost:7890/athena`）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| ListenPort | listen\$1port（已弃用） | 可选 | 7890 | 

## 身份提供者响应超时
<a name="jdbc-v3-driver-single-sign-on-login-url-identity-provider-response-timeout"></a>

驱动程序停止等待 Azure AD 发出 SAML 响应之前的时长（以秒为单位）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpResponseTimeout | idp\$1response\$1timeout（已弃用） | 可选 | 120 | 

## Preferred role
<a name="jdbc-v3-driver-single-sign-on-login-url-preferred-role"></a>

要代入的角色的 Amazon 资源名称（ARN）。有关 ARN 角色的信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| PreferredRole | preferred\$1role（已弃用） | 可选 | none | 

## 角色会话持续时间
<a name="jdbc-v3-driver-single-sign-on-login-url-role-session-duration"></a>

角色会话的持续时间（以秒为单位）。有关更多信息，请参阅 *AWS Security Token Service API 参考*中的 [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| RoleSessionDuration | Duration（已弃用） | 可选 | 3600 | 

## Lake Formation 已启用
<a name="jdbc-v3-driver-single-sign-on-login-url-lake-formation-enabled"></a>

指定是否使用 [AssumeDecoratedRoleWithSAML](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AssumeDecoratedRoleWithSAML.html) Lake Formation API 操作（而非 [AssumeRoleWithSAML](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithSAML.html) AWS STS API 操作）来检索临时 IAM 凭证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| LakeFormationEnabled | none | 可选 | FALSE | 

# DataZone IdC 凭证提供程序
<a name="jdbc-v3-driver-datazone-idc"></a>

一种身份验证机制，允许使用 IAM Identity Center 连接到 Athena 中受 DataZone 管理的数据。

## 凭证提供程序
<a name="jdbc-v3-driver-datazone-idc-credentials-provider"></a>

将用于对 AWS 的请求进行身份验证的凭证提供程序。将此参数的值设置为 `DataZoneIdc`。请注意，`AWSCredentialsProviderClass` 别名已被弃用；请改用 `CredentialsProvider` 参数名称。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 要使用的值 | 
| --- | --- | --- | --- | --- | 
| CredentialsProvider | AWSCredentialsProviderClass（已弃用） | 必需 | none | DataZoneIDC | 

## DataZone 域标识符
<a name="jdbc-v3-driver-datazone-idc-datazone-domain-identifier"></a>

要使用的 DataZone 域的标识符。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneDomainId | none | 必需 | none | 

## DataZone 环境标识符
<a name="jdbc-v3-driver-datazone-idc-datazone-environment-identifier"></a>

要使用的 DataZone 环境的标识符。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneEnvironmentId | none | 必需 | none | 

## DataZone 域区域
<a name="jdbc-v3-driver-datazone-idc-datazone-domain-region"></a>

预置您的 DataZone 域的 AWS 区域。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneDomainRegion | none | 必需 | none | 

## 区域
<a name="jdbc-v3-driver-datazone-idc-region"></a>

预置您的 DataZone 环境和 Athena 工作组的 AWS 区域。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 区域 | none | 必需 | none | 

## IAM Identity Center 发布者 URL
<a name="jdbc-v3-driver-datazone-idc-iam-identity-center-issuer-url"></a>

DataZone 域使用的 IAM Identity Center 实例的发布者 URL。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdentityCenterIssuerUrl | none | 必需 | none | 

## DataZone 端点覆盖
<a name="jdbc-v3-driver-datazone-idc-datazone-endpoint-override"></a>

要使用的 DataZone API 端点，而不是提供的 AWS 区域的默认端点。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneEndpointOverride | none | 可选 | none | 

## 启用令牌缓存
<a name="jdbc-v3-driver-datazone-idc-enable-token-caching"></a>

启用后，允许在驱动程序连接之间使用相同的 IAM Identity Center 访问令牌。这可以防止创建多个驱动程序连接的 SQL 工具启动多个浏览器窗口。如果启用此参数，我们建议您在使用后立即关闭 SQL 工具，以清除令牌缓存并要求重新进行身份验证。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| EnableTokenCaching | none | 可选 | FALSE | 

## 侦听端口
<a name="jdbc-v3-driver-datazone-idc-listen-port"></a>

侦听 IAM Identity Center 响应的端口号。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| ListenPort | none | 可选 | 8000 | 

## 身份提供者响应超时
<a name="jdbc-v3-driver-datazone-idc-identity-provider-response-time-out"></a>

驱动程序停止等待 IAM Identity Center 发出响应之前的时长（以秒为单位）。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| IdpResponseTimeout | none | 可选 | 120 | 

# DataZone IAM 凭证提供程序
<a name="jdbc-v3-driver-datazone-iamcp"></a>

一种身份验证机制，使用 IAM 凭证连接到 Athena 中受 DataZone 管理的数据。

## DataZone 域标识符
<a name="jdbc-v3-driver-datazone-iamcp-datazone-domain-identifier"></a>

要使用的 DataZone 域的标识符。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneDomainId | none | 必需 | none | 

## DataZone 环境标识符
<a name="jdbc-v3-driver-datazone-iamcp-datazone-environment-identifier"></a>

要使用的 DataZone 环境的标识符。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneEnvironmentId | none | 必需 | none | 

## DataZone 域区域
<a name="jdbc-v3-driver-datazone-iamcp-datazone-domain-region"></a>

预置您的 DataZone 域的 AWS 区域。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneDomainRegion | none | 必需 | none | 

## DataZone 端点覆盖
<a name="jdbc-v3-driver-datazone-iamcp-datazone-endpoint-override"></a>

要使用的 DataZone API 端点，而不是提供的 AWS 区域的默认端点。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| DataZoneEndpointOverride | none | 可选 | none | 

## 用户
<a name="jdbc-v3-driver-datazone-iamcp-user"></a>

您的 AWS 访问密钥 ID。有关访问密钥的更多信息，请参阅《*IAM 用户指南*》中的 [AWS 安全凭证](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 用户 | AccessKeyId | 可选 | none | 

## 密码
<a name="jdbc-v3-driver-datazone-iamcp-password"></a>

您的 AWS 密钥 ID。有关访问密钥的更多信息，请参阅《*IAM 用户指南*》中的 [AWS 安全凭证](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)。


****  

| 参数名称 | 别名 | 参数类型 | 默认 值 | 
| --- | --- | --- | --- | 
| 密码 | SecretAccessKey | 可选 | none |