Opções para a configuração do driver JDBC versão 2.1

A seguir, você pode encontrar descrições para as opções que podem ser especificadas para a versão 2.1 do driver JDBC do Amazon Redshift. As opções não diferenciam letras maiúsculas de minúsculas.

Você pode definir propriedades de configuração usando o URL de conexão. Para obter mais informações, consulte Construir o URL de conexão.

AccessKeyID

• Valor padrão: nenhum

• Tipo de dados – String

É possível especificar esse parâmetro para inserir a chave de acesso do IAM para o usuário ou o perfil. Normalmente, você pode localizar a chave observando e string existente ou perfil de usuário. Se você especificar esse parâmetro, também deverá especificar o parâmetro SecretAccessKey. Se for transmitido no URL de JDBC, o AccessKeyID deverá ser codificado por URL.

Esse parâmetro é opcional.

AllowDBuserOverride

• Valor padrão: 0

• Tipo de dados – String

Esta opção especifica se o driver usa o valor DbUser a partir da declaração SAML ou o valor especificado na propriedade de conexão DbUser no URL de conexão.

Esse parâmetro é opcional.

1

O driver usa o valor DbUser da declaração SAML.

Se a declaração SAML não especificar um valor para DBUser, o driver usa o valor especificado na propriedade de conexão DBUser. Se a propriedade de conexão também não especificar um valor, o driver usará o valor especificado no perfil de conexão.

0

O driver usa o valor DBUser especificado no valor de propriedade de conexão. DBUser.

Se a conexão DBUser não especificar um valor, o driver usará o valor especificado no perfil de conexão. Se o perfil de conexão também não especificar um valor, o driver usará o valor da declaração SAML.

App_ID

• Valor padrão – Nenhum

• Tipo de dados – String

O ID exclusivo fornecido pela OKTA associado à sua aplicação Amazon Redshift.

Este parâmetro é necessário se autenticar através do serviço Okta.

App_Name

• Valor padrão – Nenhum

• Tipo de dados – String

O nome da aplicação Okta que você usa para autenticar a conexão com o Amazon Redshift.

Esse parâmetro é opcional.

ApplicationName

• Valor padrão: null

• Tipo de dados: string

O nome da aplicação a ser passado ao Amazon Redshift para fins de auditoria.

Esse parâmetro é opcional.

AuthProfile

• Valor padrão – Nenhum

• Tipo de dados – String

O nome do perfil de autenticação a ser usado para conexão com o Amazon Redshift.

Esse parâmetro é opcional.

AutoCreate

• Valor padrão: false

• Tipo de dados – Booleano

Esta opção especifica se o driver faz com que um novo usuário seja criado quando o usuário especificado não existe.

Esse parâmetro é opcional.

verdadeiro

Se o usuário especificado por DBUser ou ID exclusivo (UID) não existir, um novo usuário com esse nome será criado.

false

O driver não faz com que novos usuários sejam criados. Se o usuário especificado não existir, a autenticação falhará.

Client_ID

• Valor padrão – Nenhum

• Tipo de dados – String

O ID do cliente a ser usado ao autenticar a conexão usando o serviço Azure AD.

Esse parâmetro é necessário se autenticar por meio do serviço Azure AD.

Client_Secret

• Valor padrão – Nenhum

• Tipo de dados – String

O Segredo do cliente a ser usado ao autenticar a conexão usando o serviço Azure AD.

Esse parâmetro é necessário se autenticar por meio do serviço Azure AD.

ClusterID

• Valor padrão – Nenhum

• Tipo de dados – String

O nome do cluster do Amazon Redshift ao qual você quer se conectar. O driver tenta detectar esse parâmetro a partir de um determinado host. Se você estiver usando um Network Load Balancer (NLB) e se conectando via IAM, o driver não conseguirá detectá-lo, por isso é possível configurá-lo usando essa opção de conexão.

Esse parâmetro é opcional.

Compactação

• Valor padrão: desativado

• Tipo de dados – String

O método de compactação usado na comunicação via protocolo com fio entre o servidor do Amazon Redshift e o cliente ou o driver.

Esse parâmetro é opcional.

Especifique os seguintes valores:

• lz4

  Define o método de compactação usado na comunicação via protocolo com fio com o Amazon Redshift como lz4.

• off

  Não usa a compactação na comunicação via protocolo com fio com o Amazon Redshift.

connectTimeout

• Valor padrão: 10

• Tipo de dados: inteiro

O valor de tempo limite a ser usado para operações de conexão de soquete. Se o tempo necessário para estabelecer uma conexão do Amazon Redshift exceder esse valor, a conexão será considerada indisponível. O tempo limite é especificado em segundos. O valor 0 significa que nenhum tempo limite foi especificado.

Esse parâmetro é opcional.

connectionTimezone

• Valor padrão: LOCAL

• Tipo de dados – String

O fuso horário no nível da sessão.

Esse parâmetro é opcional.

Especifique os seguintes valores:

LOCAL

Configura o fuso horário no nível da sessão para o fuso horário JVM LOCAL.

SERVER

Configura o fuso horário no nível da sessão de acordo com o fuso horário definido para o usuário no servidor Amazon Redshift. Você pode configurar fusos horários no nível da sessão para usuários com o seguinte comando:

ALTER USER
[...]
SET TIMEZONE TO [...];

databaseMetadataCurrentDbOnly

• Valor padrão: true

• Tipo de dados – Booleano

Esta opção especifica se a API de metadados recupera dados de todos os bancos de dados acessíveis ou somente do banco de dados conectado.

Esse parâmetro é opcional.

Especifique os seguintes valores:

verdadeiro

A aplicação recupera metadados de um único banco de dados.

false

A aplicação recupera metadados de todos os bancos de dados acessíveis.

DbUser

• Valor padrão – Nenhum

• Tipo de dados – String

O ID de usuário a ser usado com sua conta do Amazon Redshift. Você pode usar um ID que não existe no momento se você tiver habilitado a propriedade AutoCreate.

Esse parâmetro é opcional.

DbGroups

• Valor padrão – PUBLIC

• Tipo de dados – String

Uma lista separada por vírgulas de nomes de grupos de bancos de dados existentes que DBUser ingressa à sessão atual.

Esse parâmetro é opcional.

DBNAME

• Valor padrão: null

• Tipo de dados – String

É o nome do banco de dados ao qual se conectar. Você pode usar essa opção para especificar o nome do banco de dados na URL da conexão JDBC.

Esse parâmetro é obrigatório. Você deve especificar o nome do banco de dados, na URL da conexão ou nas propriedades de conexão da aplicação cliente.

defaultRowFetchSize

• Valor padrão: 0

• Tipo de dados — Inteiro

Esta opção especifica um valor padrão para getFetchSize.

Esse parâmetro é opcional.

Especifique os seguintes valores:

0

Obtém todas as linhas em uma única operação.

Inteiro positivo

Número de linhas a serem obtidas do banco de dados para cada iteração de busca do ResultSet.

DisableIsValidQuery

• Valor padrão – False

• Tipo de dados – Booleano

Esta opção especifica se o driver envia uma nova consulta de banco de dados ao usar o método Connection.isValid() para determinar se a conexão de banco de dados está ativa.

Esse parâmetro é opcional.

verdadeiro

O driver não envia uma consulta ao usar Connection.isValid() para determinar se a conexão de banco de dados está ativa. Isso pode fazer com que o driver identifique incorretamente a conexão de banco de dados como ativa se o servidor de banco de dados foi encerrado inesperadamente.

false

O driver envia uma consulta ao usar Connection.isValid() para determinar se a conexão de banco de dados está ativa.

enableFetchRingBuffer

• Valor padrão: true

• Tipo de dados – Booleano

Esta opção especifica que o driver obtém linhas usando um buffer de anel em um thread separado. O parâmetro fetchRingBufferSize especifica o tamanho do buffer do anel.

Se uma transação detectar uma instrução que contém vários comandos SQL separados por pontos e vírgulas, o buffer circular de busca dessa transação será definido como false. O valor de enableFetchRingBuffer não muda.

Esse parâmetro é opcional.

enableMultiSqlSupport

• Valor padrão: true

• Tipo de dados – Booleano

Esta opção especifica se deseja processar vários comandos SQL separados por ponto-e-vírgula em uma instrução.

Esse parâmetro é opcional.

Especifique os seguintes valores:

verdadeiro

O driver processa vários comandos SQL, separados por ponto-e-vírgula, em um objeto de instrução.

false

O driver retorna um erro para vários comandos SQL em uma única instrução.

fetchRingBufferSize

• Valor padrão – 1G

• Tipo de dados – String

Esta opção especifica o tamanho do buffer de anel usado ao buscar o conjunto de resultados. Você pode especificar um tamanho em bytes, por exemplo, 1K para 1 KB, 5000 para 5.000 bytes, 1M para 1 MB, 1G para 1 GB e assim por diante. Você também pode especificar uma porcentagem de memória de heap. O driver para de buscar linhas ao atingir o limite. A busca é retomada quando a aplicação lê linhas e libera espaço no buffer de anel.

Esse parâmetro é opcional.

ForceLowercase

• Valor padrão: false

• Tipo de dados – Booleano

Esta opção especifica se o driver coloca em minúsculas todos os grupos de banco de dados (DbGroups) enviados do provedor de identidades para o Amazon Redshift ao usar a autenticação única.

Esse parâmetro é opcional.

verdadeiro

O driver coloca em minúsculas todos os grupos de banco de dados que são enviados do provedor de identidades.

false

O driver não altera grupos de banco de dados.

groupFederation

• Valor padrão: false

• Tipo de dados – Booleano

Essa opção especifica se grupos de IDP do Amazon Redshift serão usados ou não. Isso é compatível com a API GetClusterCredentialsV2.

Esse parâmetro é opcional.

verdadeiro

Use grupos de provedores de identidade (IDP) do Amazon Redshift.

false

Use a API STS e GetClusterCredentials para federação de usuários e especifique explicitamente DbGroups para a conexão.

HOST

• Valor padrão: null

• Tipo de dados – String

O nome de host do servidor do Amazon Redshift ao qual se conectar. Você pode usar essa opção para especificar o nome de host na URL da conexão JDBC.

Esse parâmetro é obrigatório. Você deve especificar o nome do host, na URL da conexão ou nas propriedades de conexão da aplicação cliente.

IAMDisableCache

• Valor padrão: false

• Tipo de dados – Booleano

Essa opção especifica se as credenciais do IAM são armazenadas em cache.

Esse parâmetro é opcional.

verdadeiro

As credenciais do IAM não são armazenadas em cache.

false

As credenciais do IAM são armazenadas em cache. Isso melhora a performance quando solicitações para o API Gateway são limitadas, por exemplo.

IAMDuration

• Valor padrão – 900

• Tipo de dados — Inteiro

O período de tempo, em segundos, até que as credenciais temporárias do IAM expirem.

• Valor mínimo – 900

• Valor máximo – 3.600

Esse parâmetro é opcional.

Idc_Client_Display_Name

• Valor padrão: driver JDBC do Amazon Redshift

• Tipo de dados – String

O nome de exibição a ser usado para o cliente que está usando o BrowserIdcAuthPlugin.

Esse parâmetro é opcional.

Idc_Region

• Valor padrão – Nenhum

• Tipo de dados – String

A região AWS onde a instância do IAM Identity Center está localizada.

Esse parâmetro só é necessário durante a autenticação usando BrowserIdcAuthPlugin na opção de configuração plugin_name.

IdP_Host

• Valor padrão – Nenhum

• Tipo de dados – String

O host IdP (provedor de identidades) que você está usando para autenticar no Amazon Redshift. Isso pode ser especificado na string de conexão ou em um perfil.

Esse parâmetro é opcional.

IdP_Port

• Valor padrão – Nenhum

• Tipo de dados – String

A porta usada por um IdP (provedor de identidades). Você pode especificar a porta na string da conexão ou em um perfil. A porta padrão é 5439. Dependendo da porta selecionada ao criar, modificar ou migrar o cluster, permita o acesso à porta selecionada.

Esse parâmetro é opcional.

IdP_Tenant

• Valor padrão – Nenhum

• Tipo de dados – String

O ID de locatário do Azure AD para sua aplicação Amazon Redshift.

Esse parâmetro é necessário se autenticar por meio do serviço Azure AD.

IdP_Response_Timeout

• Valor padrão – 120

• Tipo de dados — Inteiro

A quantidade de tempo, em segundos, que o driver aguarda pela resposta SAML do provedor de identidades ao usar os serviços SAML ou Azure AD por meio de um plug-in de navegador.

Esse parâmetro é opcional.

iniFile

• Valor padrão – Nenhum

• Tipo de dados – String

O caminho completo do arquivo .ini, incluindo o nome do arquivo. Por exemplo:

IniFile="C:\tools\rsjdbc.ini"

Para obter informações sobre o arquivo .ini, consulte Criar arquivos de inicialização (.ini) para o driver JDBC versão 2.1.

Esse parâmetro é opcional.

IniSection

• Valor padrão – Nenhum

• Tipo de dados – String

O nome de uma seção no arquivo.ini que contém as opções de configuração. Para obter informações sobre o arquivo .ini, consulte Criar arquivos de inicialização (.ini) para o driver JDBC versão 2.1.

O exemplo a seguir especifica a seção [Prod] do arquivo.ini:

IniSection="Prod"

Esse parâmetro é opcional.

isServerless

• Valor padrão: false

• Tipo de dados – Booleano

Essa opção especifica se o host do endpoint do Amazon Redshift é uma instância com tecnologia sem servidor. O driver tenta detectar esse parâmetro a partir de um determinado host. Se você estiver usando um Network Load Balancer (NLB), o driver não conseguirá detectá-lo, então é possível configurá-lo aqui.

Esse parâmetro é opcional.

verdadeiro

O host do endpoint do Amazon Redshift é uma instância com tecnologia sem servidor.

false

O host do endpoint do Amazon Redshift é um cluster provisionado.

Issuer_Url

• Valor padrão – Nenhum

• Tipo de dados – String

Aponta para o endpoint da instância do servidor do Centro de Identidade do AWS IAM.

Esse parâmetro só é necessário durante a autenticação usando BrowserIdcAuthPlugin na opção de configuração plugin_name.

Listen_Port

• Valor padrão - 7890

• Tipo de dados: inteiro

A porta que o driver usa para receber a resposta SAML do provedor de identidades ou o código de autorização ao usar os serviços SAML, Azure AD ou Centro de Identidade do AWS IAM por meio de um plug-in do navegador.

Esse parâmetro é opcional.

Login_URL

• Valor padrão – Nenhum

• Tipo de dados – String

A URL do recurso no site do provedor de identidades ao usar os serviços SAML ou Azure AD por meio de um plug-in do navegador.

Esse parâmetro é necessário se autenticar com os serviços SAML ou Azure AD por meio de um plug-in de navegador.

loginTimeout

• Valor padrão: 0

• Tipo de dados — Inteiro

O número de segundos a aguardar antes de atingir o tempo limite ao conectar e autenticar no servidor. Se o tempo para estabelecer a conexão for maior do que esse limite, a conexão é cancelada.

Quando esta propriedade é definida como 0, as conexões não atingem o tempo limite.

Esse parâmetro é opcional.

loginToRp

• Valor padrão: urn:amazon:webservices

• Tipo de dados – String

A relação de confiança de parte confiável que você deseja usar para o tipo de autenticação do AD FS.

Esse parâmetro é opcional.

LogLevel

• Valor padrão: 0

• Tipo de dados — Inteiro

Use essa propriedade para ativar ou desativar o registro em logs no driver e especificar a quantidade de detalhes incluídos nos arquivos de log.

Habilite o registro em log somente o tempo suficiente para capturar um problema. O registro em log diminui a performance e pode consumir uma grande quantidade de espaço em disco.

Esse parâmetro é opcional.

Defina o parâmetro com um dos seguintes valores:

0

Desative todos os registros em log.

1

Habilita o registro em logs no nível FATAL, que registra eventos de erro muito graves que levarão o driver a anular.

2

Habilita o registro em logs no nível ERROR, que registra eventos de erro que ainda permitem que o driver continue sendo executado.

3

Habilite o log no nível WARNING, que registra eventos que podem resultar em um erro se a ação não for executada.

4

Habilita o registro em logs no nível INFO, que registra informações gerais que descrevem o progresso do driver.

5

Habilita o registro em logs no nível DEBUG, que registra informações detalhadas que sejam úteis para depurar o driver.

6

Habilita o registro em log no nível TRACE, que registra todas as atividades do driver.

Quando o registro em log está habilitado, o driver produz os seguintes arquivos de log no local especificado na propriedade LogPath:

• redshift_jdbc.log — Arquivo que registra a atividade do driver que não é específica para uma conexão.

• redshift_jdbc_connection_[Number].log — Arquivo para cada conexão feita com o banco de dados, onde [Number] é um número que distingue cada arquivo de log dos outros. Este arquivo registra a atividade do driver que é específica para a conexão.

Se o valor LogPath for inválido, o driver envia as informações registradas para o fluxo de saída padrão, System.out.

LogPath

• Valor padrão – O diretório de trabalho atual.

• Tipo de dados – String

O caminho completo para a pasta onde o driver salva arquivos de log quando a propriedade DSILogLevel está habilitada.

Para ter certeza de que o URL de conexão é compatível com todas as aplicações JDBC, recomendamos que você escape as barras invertidas (\) no caminho do arquivo digitando outra barra invertida.

Esse parâmetro é opcional.

OverrideSchemaPatternType

• Valor padrão: null

• Tipo de dados: inteiro

Esta opção especifica se o tipo de consulta usado em chamadas de getTables deve ser substituído.

0

Nenhuma consulta universal de esquema

1

Consulta de esquema local

2

Consulta de esquema externo

Esse parâmetro é opcional.

Partner_SPID

• Valor padrão – Nenhum

• Tipo de dados – String

O valor SPID (ID do provedor de serviços) do parceiro a ser usado ao autenticar a conexão usando o serviço PingFederate.

Esse parâmetro é opcional.

Senha

• Valor padrão – Nenhum

• Tipo de dados – String

Ao se conectar usando a autenticação do IAM por meio de um IDP, essa é a senha do servidor IDP_Host. Ao usar a autenticação padrão, isso pode ser usado para a senha do banco de dados do Amazon Redshift em vez de PWD.

Esse parâmetro é opcional.

Plugin_Name

• Valor padrão – Nenhum

• Tipo de dados – String

O nome de classe totalmente qualificado para implementar um plugin de provedor de credenciais específico.

Esse parâmetro é opcional.

Algumas opções compatíveis estão listadas:

• AdfsCredentialsProvider: Serviço de Federação do Active Directory.

• AzureCredentialsProvider: Serviço Microsoft Azure Active Directory (AD).

• BasicJwtCredentialsProvider: Serviço JSON Web Tokens (JWT)

• BasicSamlCredentialsProvider: credenciais de Security Assertion Markup Language (SAML) que você pode usar com muitos provedores de serviços SAML.

• BrowserAzureCredentialsProvider: navegador do Serviço Microsoft Azure Active Directory (AD).

• BrowserAzureOAuth2CredentialsProvider: navegador do Serviço Microsoft Azure Active Directory (AD) para autenticação nativa.

• BrowserIdcAuthPlugin: um plug-in de autorização que usa o Centro de Identidade do AWS IAM.

• BrowserSamlCredentialsProvider: navegador SAML para serviços SAML como Okta, Ping ou ADFS.

• IdpTokenAuthPlugin: um plug-in de autorização que aceita um token do Centro de Identidade do AWS IAM ou tokens de identidade baseados em JSON (JWT) do OpenID Connect (OIDC) de qualquer provedor de identidades da web vinculado ao Centro de Identidade do AWS IAM.

• OktaCredentialsProvider: serviço do Okta.

• PingCredentialsProvider: serviço do PingFederate.

PORT

• Valor padrão: null

• Tipo de dados: inteiro

A porta do servidor do Amazon Redshift ao qual se conectar. Você pode usar essa opção para especificar a porta na URL da conexão JDBC.

Esse parâmetro é opcional.

Preferred_Role

• Valor padrão – Nenhum

• Tipo de dados – String

A função do IAM que você deseja assumir durante a conexão com o Amazon Redshift.

Esse parâmetro é opcional.

Perfil

• Valor padrão – Nenhum

• Tipo de dados – String

O nome do perfil a ser usado para autenticação do IAM. Este perfil contém quaisquer propriedades de conexão adicionais não especificadas na cadeia de conexão.

Esse parâmetro é opcional.

PWD

• Valor padrão – Nenhum

• Tipo de dados – String

A senha correspondente ao nome de usuário do Amazon Redshift que você forneceu usando o UID da propriedade.

Esse parâmetro é opcional.

queryGroup

• Valor padrão: null

• Tipo de dados – String

Esta opção atribui uma consulta a uma fila em tempo de execução atribuindo sua consulta ao grupo de consulta apropriado. O grupo de consulta está definido para a sessão. Todas as consultas que são executadas na conexão pertencem a esse grupo de consultas.

Esse parâmetro é opcional.

readOnly

• Valor padrão: false

• Tipo de dados – Booleano

Essa propriedade especifica se o driver está em modo somente leitura.

Esse parâmetro é opcional.

verdadeiro

A conexão está no modo somente leitura e não pode gravar no armazenamento de dados.

false

A conexão não está no modo somente leitura e pode gravar no armazenamento de dados.

Região

• Valor padrão: null

• Tipo de dados – String

Esta opção especifica a opção da região da AWS em que o cluster está localizado. Se você especificar a opção StsEndPoint, a opção Região será ignorada. A operação de API GetClusterCredentials do Redshift também usa a opção Região.

Esse parâmetro é opcional.

reWriteBatchedInserts

• Valor padrão: false

• Tipo de dados – Booleano

Esta opção permite a otimização para reescrever e combinar instruções INSERT compatíveis em lotes.

Esse parâmetro é opcional.

reWriteBatchedInsertsSize

• Valor padrão – 128

• Tipo de dados — Inteiro

Esta opção permite a otimização para reescrever e combinar instruções INSERT compatíveis em lotes. Este valor deve aumentar exponencialmente na potência de 2.

Esse parâmetro é opcional.

roleArn

• Valor padrão – Nenhum

• Tipo de dados – String

O nome do recurso da Amazon (ARN) da função. Certifique-se de especificar esse parâmetro ao especificar BasicJwtCredentialsProvider para a opção Plugin_Name. Especifique o ARN no seguinte formato:

arn:partition:service:region:account-id:resource-id

Esse parâmetro será necessário se você especificar BasicJwtCredentialsProvider para a opção Plugin_Name.

roleSessionName

• Valor padrão: jwt_redshift_session

• Tipo de dados – String

Um identificador para a sessão de função assumida. Normalmente, você passa o nome ou identificador que está associado ao usuário da aplicação. As credenciais de segurança temporárias que o aplicativo usa estão associadas a esse usuário. É possível especificar esse parâmetro quando você especificar BasicJwtCredentialsProvider para a opção Plugin_Name.

Esse parâmetro é opcional.

scope

• Valor padrão – Nenhum

• Tipo de dados – String

Uma lista separada por espaços de escopos com os quais o usuário pode consentir. Você especifica esse parâmetro para que sua aplicação do Microsoft Azure possa obter consentimento para APIs que você deseja chamar. É possível especificar esse parâmetro ao especificar BrowserAzureOAuth2CredentialsProvider para a opção Plugin_Name.

Esse parâmetro é obrigatório para o plug-in BrowserAzureOAuth2CredentialsProvider.

SecretAccessKey

• Valor padrão – Nenhum

• Tipo de dados – String

A chave de acesso do IAM para o usuário ou função. Se for especificado, AccessKeyID também deve ser especificado. Se for transmitido no URL de JDBC, o SecretAccessKey deverá ser codificado por URL.

Esse parâmetro é opcional.

SessionToken

• Valor padrão – Nenhum

• Tipo de dados – String

O token temporário de sessão do IAM associado à função do IAM que você está usando para autenticar. Se for passado no URL de JDBC, o token de sessão temporário do IAM deverá ser codificado por URL.

Esse parâmetro é opcional.

serverlessAcctId

• Valor padrão: null

• Tipo de dados – String

O ID da conta do Amazon Redshift Serverless. O driver tenta detectar esse parâmetro a partir de um determinado host. Se você estiver usando um Network Load Balancer (NLB), o driver não conseguirá detectá-lo, então é possível configurá-lo aqui.

Esse parâmetro é opcional.

serverlessWorkGroup

• Valor padrão: null

• Tipo de dados – String

O nome do grupo de trabalho do Amazon Redshift Serverless. O driver tenta detectar esse parâmetro a partir de um determinado host. Se você estiver usando um Network Load Balancer (NLB), o driver não conseguirá detectá-lo, então é possível configurá-lo aqui.

Esse parâmetro é opcional.

socketFactory

• Valor padrão: null

• Tipo de dados – String

Esta opção especifica uma fábrica de soquetes para criação de soquetes.

Esse parâmetro é opcional.

socketTimeout

• Valor padrão: 0

• Tipo de dados — Inteiro

O número de segundos de espera nas operações de leitura de um soquete antes de se atingir o tempo limite. Se a operação demorar mais do que esse limite, a conexão será fechada. Quando esta propriedade é definida como 0, a conexão não atinge o tempo limite.

Esse parâmetro é opcional.

SSL

• Valor padrão: TRUE

• Tipo de dados – String

Use esta propriedade para ativar ou desativar o SSL para a conexão.

Esse parâmetro é opcional.

Especifique os seguintes valores:

VERDADEIRO

O driver se conecta ao servidor por meio de SSL.

FALSE

O driver se conecta ao servidor sem usar SSL. Essa opção não é compatível com a autenticação do IAM.

Você também pode configurar a propriedade AuthMech.

SSL_Insecure

• Valor padrão – true

• Tipo de dados – String

Esta propriedade indica se o certificado de servidor de hosts IDP deve ser verificado.

Esse parâmetro é opcional.

Especifique os seguintes valores:

verdadeiro

O driver não verifica a autenticidade do certificado do servidor IDP.

false

O driver verifica a autenticidade do certificado do servidor IDP.

SSLCert

• Valor padrão – Nenhum

• Tipo de dados – String

O caminho completo de um arquivo .pem ou .crt que contém certificados CA confiáveis adicionais para verificar a instância do servidor Amazon Redshift do quando o SSL for usado.

Este parâmetro é necessário se SSLKey for especificado.

SSLFactory

• Valor padrão – Nenhum

• Tipo de dados – String

A fábrica SSL a ser usada ao se conectar ao servidor por meio de TLS/SSL sem usar um certificado de servidor.

SSLkey

• Valor padrão – Nenhum

• Tipo de dados – String

O caminho completo do arquivo .der que contém o arquivo de chave PKCS8 para verificar os certificados especificados em SSLCert.

Este parâmetro é necessário se SSLCert for especificado.

SSLMode

• Valor padrão – verify-ca

• Tipo de dados – String

Use essa propriedade para especificar como o driver valida certificados quando TLS/SSL está habilitado.

Esse parâmetro é opcional.

Especifique os seguintes valores:

verify-ca

O driver verifica se o certificado vem de uma autoridade de certificação (CA) confiável.

verify-full

O controlador verifica se o certificado vem de uma AC fidedigna e se o nome de host no certificado corresponde ao nome de host especificado na URL de ligação.

SSLPassword

• Valor padrão: 0

• Tipo de dados – String

A senha para o arquivo de chave criptografada especificado em SSLKey.

Esse parâmetro é necessário se SSLKey for especificado e o arquivo de chave for criptografado.

SSLRootCert

• Valor padrão – Nenhum

• Tipo de dados – String

O caminho completo de um arquivo .pem ou .crt que contém o certificado CA raiz que verificará a instância do Amazon Redshift Server do quando o SSL for usado.

StsEndpointUrl

• Valor padrão: null

• Tipo de dados – String

É possível especificar um endpoint AWS Security Token Service (AWS STS). Se você especificar essa opção, a opção Região será ignorada. Você só pode especificar um protocolo seguro (HTTPS) para esse endpoint.

tcpKeepAlive

• Valor padrão: TRUE

• Tipo de dados – String

Use essa propriedade para ativar ou desativar keepalives TCP.

Esse parâmetro é opcional.

Especifique os seguintes valores:

VERDADEIRO

O driver usa keepalives TCP para evitar que o tempo limite das conexões se esgote.

FALSE

O driver não usa keepalives TCP.

token

• Valor padrão – Nenhum

• Tipo de dados – String

O Centro de Identidade do AWS IAM forneceu um token de acesso ou um token web JSON (JWT) do OpenID Connect (OIDC) fornecido por um provedor de identidades da web vinculado ao Centro de Identidade do AWS IAM. A aplicação deve gerar esse token autenticando o usuário da aplicação com o Centro de Identidade do AWS IAM ou um provedor de identidades vinculado ao Centro de Identidade do AWS IAM.

Esse parâmetro funciona com IdpTokenAuthPlugin.

token_type

• Valor padrão – Nenhum

• Tipo de dados – String

O tipo de token que está sendo usado no IdpTokenAuthPlugin.

Especifique os seguintes valores:

ACCESS_TOKEN

Insira se você usar um token de acesso fornecido pelo Centro de Identidade do AWS IAM.

EXT_JWT

Insira se você usar um token web JSON (JWT) do OpenID Connect (OIDC) fornecido por um provedor de identidades baseado na web integrado ao Centro de Identidade do AWS IAM.

Esse parâmetro funciona com IdpTokenAuthPlugin.

UID

• Valor padrão – Nenhum

• Tipo de dados – String

O nome de usuário do banco de dados que você usa para acessar o banco de dados.

Esse parâmetro é obrigatório.

Usuário

• Valor padrão – Nenhum

• Tipo de dados – String

Ao se conectar usando a autenticação do IAM por meio de um IdP, esse é o nome de usuário do servidor idp_host. Ao usar a autenticação padrão, você pode usá-lo como nome de usuário do banco de dados do Amazon Redshift.

Esse parâmetro é opcional.

webIdentityToken

• Valor padrão – Nenhum

• Tipo de dados – String

O token de acesso OAuth 2.1 ou token OpenID Connect ID fornecido pelo provedor de identidades. Sua aplicação deve obter esse token autenticando o usuário da sua aplicação com um provedor de identidades da web. Certifique-se de especificar esse parâmetro ao especificar BasicJwtCredentialsProvider para a opção Plugin_Name.

Esse parâmetro será necessário se você especificar BasicJwtCredentialsProvider para a opção Plugin_Name.