Opciones de configuración del controlador JDBC versión 2.1

A continuación, puede encontrar descripciones relativas a las opciones que puede especificar para la versión 2.1 del controlador JDBC de Amazon Redshift. Las opciones de configuración no distinguen entre mayúsculas y minúsculas.

Puede establecer las propiedades de configuración mediante la URL de conexión. Para obtener más información, consulte Creación de la URL de conexión.

AccessKeyID

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Puede especificar este parámetro para ingresar la clave de acceso de IAM correspondiente al usuario o rol. Por lo general, puede localizar la clave si busca en una cadena o en un perfil de usuario existente. Si especifica este parámetro, también debe especificar el parámetro SecretAccessKey. Si se pasa en la URL de JDBC, AccessKeyID debe estar codificado en URL.

Este parámetro es opcional.

AllowDBUserOverride

• Valor predeterminado: 0

• Tipo de datos: cadena

Esta opción especifica si el controlador utiliza el valor DbUser de la aserción SAML o el valor que se especifica en la propiedad de conexión DbUser en la URL de conexión.

Este parámetro es opcional.

1

El controlador utiliza el valor DbUser de la aserción SAML.

Si la aserción SAML no especifica un valor para DBUser, el controlador utiliza el valor especificado en la propiedad de conexión DBUser. Si la propiedad de conexión no especifica un valor, el controlador utiliza el valor especificado en el perfil de conexión.

0

El controlador utiliza el valor DBUser especificado en la propiedad de conexión DBUser.

Si la propiedad de conexión DBUser no especifica un valor, el controlador utiliza el valor especificado en el perfil de conexión. Además, si el perfil de conexión no especifica un valor, el controlador utiliza el valor de la aserción SAML.

App_ID

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El ID único proporcionado por Okta que se asocia a su aplicación de Amazon Redshift.

Este parámetro es necesario si la autenticación se realiza a través del servicio de Okta.

App_Name

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre de la aplicación Okta que utiliza en la autenticación de la conexión con Amazon Redshift.

Este parámetro es opcional.

ApplicationName

• Valor predeterminado: nulo

• Tipo de datos: cadena

Nombre de la aplicación que se va a pasar a Amazon Redshift con fines de auditoría.

Este parámetro es opcional.

AuthProfile

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre del perfil de autenticación que se utilizará para conectarse a Amazon Redshift.

Este parámetro es opcional.

AutoCreate

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si el controlador logra que se cree un nuevo usuario cuando el usuario especificado no existe.

Este parámetro es opcional.

true

Si el usuario especificado por DBUser o ID único (UID) no existe, se crea un nuevo usuario con ese nombre.

false

El controlador no logra que se creen nuevos usuarios. Si el usuario especificado no existe, se produce un error en la autenticación.

Client_ID

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El ID de cliente que se utilizará al autenticar la conexión mediante el servicio Azure AD.

Este parámetro es necesario si la autenticación se realiza a través del servicio Azure AD.

Client_Secret

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El secreto del cliente que se utilizará al autenticar la conexión mediante el servicio Azure AD.

Este parámetro es necesario si la autenticación se realiza a través del servicio Azure AD.

ID del clúster

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre del clúster de Amazon Redshift al que desea conectarse. El controlador intenta detectar este parámetro desde el host dado. Si utiliza un equilibrador de carga de red (NLB) y se conecta a través de IAM, el controlador no lo detectará, por lo que puede configurarlo con esta opción de conexión.

Este parámetro es opcional.

Compresión

• Valor predeterminado: desconectado

• Tipo de datos: cadena

Método de compresión utilizado para la comunicación mediante protocolo de conexión entre el servidor de Amazon Redshift y el cliente o el controlador.

Este parámetro es opcional.

Puede especificar los valores siguientes:

• lz4

  Establece el método de compresión utilizado para la comunicación mediante protocolo de conexión con Amazon Redshift a lz4.

• off

  No utiliza la compresión para la comunicación mediante protocolo de conexión con Amazon Redshift.

connectTimeout

• Valor predeterminado: 10

• Tipo de datos: entero

Valor de tiempo de espera que se utilizará para las operaciones de conexión de socket. Si el tiempo necesario para establecer una conexión de Amazon Redshift supera este valor, se considera que la conexión no está disponible. El tiempo de espera se especifica en segundos. Un valor de 0 indica que no se especifica ningún tiempo de espera.

Este parámetro es opcional.

connectionTimezone

• Valor predeterminado: LOCAL

• Tipo de datos: cadena

Zona horaria en el nivel de sesión.

Este parámetro es opcional.

Puede especificar los valores siguientes:

LOCAL

Configura la zona horaria en el nivel de sesión en la zona horaria de la JVM LOCAL.

SERVER

Configura la zona horaria en el nivel de sesión en la zona horaria establecida para el usuario en el servidor de Amazon Redshift. Puede configurar las zonas horarias en el nivel de sesión para los usuarios con el siguiente comando:

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

databaseMetadataCurrentDbOnly

• Valor predeterminado: true

• Tipos de datos: booleano

Esta opción especifica si la API de metadatos recupera datos de todas las bases de datos accesibles o únicamente de la base de datos que está conectada.

Este parámetro es opcional.

Puede especificar los valores siguientes:

true

La aplicación recupera los metadatos de una base de datos única.

false

La aplicación recupera los metadatos de todas las bases de datos a las que se puede acceder.

DbUser

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El ID de usuario que se utilizará con su cuenta de Amazon Redshift. Puede utilizar un ID que no exista actualmente si ha habilitado la propiedad AutoCreate.

Este parámetro es opcional.

DbGroups

• Valor predeterminado: PUBLIC

• Tipo de datos: cadena

Una lista separada por comas de los nombres de grupos de bases de datos existentes que DBUser une para la sesión actual.

Este parámetro es opcional.

DBNAME

• Valor predeterminado: nulo

• Tipo de datos: cadena

Nombre de la base de datos a la que se va a conectar. Puede utilizar esta opción para especificar el nombre de la base de datos en la URL de conexión de JDBC.

Este parámetro es obligatorio. Debe especificar el nombre de la base de datos, ya sea en la URL de conexión o en las propiedades de conexión de la aplicación cliente.

defaultRowFetchSize

• Valor predeterminado: 0

• Tipo de datos: entero

Esta opción especifica un valor predeterminado para getFetchSize.

Este parámetro es opcional.

Puede especificar los valores siguientes:

0

Recupere todas las filas en una sola operación.

Entero positivo

Número de filas que se recuperan de la base de datos en cada una de las iteraciones de recuperación de ResultSet.

DisableIsValidQuery

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si el controlador envía una nueva consulta a la base de datos cuando se utiliza el método Connection.isValid() para determinar si la conexión a la base de datos se encuentra activa.

Este parámetro es opcional.

true

El controlador no envía una consulta cuando se utiliza el método Connection.isValid() para determinar si la conexión a la base de datos se encuentra activa. Con ello, es posible que el controlador identifique de manera incorrecta la conexión a la base de datos como activa en caso de que el servidor de la base de datos se haya apagado inesperadamente.

false

El controlador envía una consulta cuando se utiliza el método Connection.isValid() para determinar si la conexión a la base de datos se encuentra activa.

enableFetchRingBuffer

• Valor predeterminado: true

• Tipos de datos: booleano

Esta opción especifica que el controlador recupera las filas mediante un búfer de anillo en un subproceso separado. El parámetro fetchRingBufferSize determina el tamaño del búfer de anillo.

Si una transacción detecta una instrucción que contiene varios comandos SQL separados por punto y coma, el búfer del anillo de recuperación de esa transacción se establece en falso. El valor de enableFetchRingBuffer no cambia.

Este parámetro es opcional.

enableMultiSqlSupport

• Valor predeterminado: true

• Tipos de datos: booleano

Esta opción especifica si se deben procesar varios comandos SQL separados por punto y coma en una instrucción.

Este parámetro es opcional.

Puede especificar los valores siguientes:

true

El controlador procesa varios comandos SQL, separados por punto y coma, en un objeto Statement.

false

El controlador devuelve un error en caso de varios comandos SQL en un mismo Statement.

fetchRingBufferSize

• Valor predeterminado: 1G

• Tipo de datos: cadena

Esta opción especifica el tamaño del búfer de anillo utilizado mientras se recupera el conjunto de resultados. Puede especificar un tamaño expresado en bytes; por ejemplo, 1K para 1 KB, 5000 para 5000 bytes, 1M para 1 MB, 1G para 1 GB, etc. También puede especificar un porcentaje de memoria heap. El controlador deja de recuperar filas una vez que alcanza el límite establecido. La recuperación se reanuda en el momento en que la aplicación hace una lectura de las filas y libera espacio en el búfer de anillo.

Este parámetro es opcional.

ForceLowercase

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si el controlador escribe en minúsculas todos los grupos de bases de datos (DbGroups) que se envían desde el proveedor de identidad a Amazon Redshift cuando se utiliza la autenticación de inicio de sesión único.

Este parámetro es opcional.

true

El controlador escribe en minúsculas todos los grupos de bases de datos que se envían desde el proveedor de identidad.

false

El controlador no modifica los grupos de la base de datos.

groupFederation

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si se utilizarán grupos de IDP de Amazon Redshift. Esto es compatible con la API GetClusterCredentialSV2.

Este parámetro es opcional.

true

Utilice grupos de proveedores de identidad (IDP) de Amazon Redshift.

false

Utilice la API STS y GetClusterCredentials para la federación de usuarios y especifique explícitamente DbGroups para la conexión.

HOST

• Valor predeterminado: nulo

• Tipo de datos: cadena

El nombre del host del servidor de Amazon Redshift al que va a conectarse. Puede utilizar esta opción para especificar el nombre de host en la URL de conexión de JDBC.

Este parámetro es obligatorio. Debe especificar el nombre de host, ya sea en la URL de conexión o en las propiedades de conexión de la aplicación cliente.

IAMDisableCache

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si las credenciales de IAM se almacenan en caché.

Este parámetro es opcional.

true

Las credenciales de IAM no se almacenan en caché.

false

Las credenciales de IAM se almacenan en caché. De este modo, se mejora el rendimiento en los casos en que, por ejemplo, las solicitudes a API Gateway tienen limitación controlada.

IAMDuration

• Valor predeterminado: 900

• Tipo de datos: entero

El tiempo, en segundos, hasta que se vencen las credenciales temporales de IAM.

• Valor mínimo: 900

• Valor máximo: 3600

Este parámetro es opcional.

Idc_Client_Display_Name

• Valor predeterminado: controlador JDBC de Amazon Redshift

• Tipo de datos: cadena

El nombre para mostrar que se utilizará para el cliente que usa BrowserIdcAuthPlugin.

Este parámetro es opcional.

Idc_Region

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Es la región de AWS en la que se encuentra la instancia del IAM Identity Center.

Este parámetro es necesario solo cuando en la autenticación se utiliza BrowserIdcAuthPlugin en la opción de configuración plugin_name.

IdP_Host

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El alojamiento del IdP (proveedor de identidad) que utiliza para la autenticación en Amazon Redshift. Esto puede especificarse tanto en la cadena de conexión como en un perfil.

Este parámetro es opcional.

IdP_Port

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El puerto usado por un IdP (proveedor de identidad). Se puede especificar el puerto en la cadena de conexión o en un perfil. El puerto predeterminado es 5439. Según el puerto que haya seleccionado al crear, modificar o migrar el clúster, se permitirá el acceso al puerto seleccionado.

Este parámetro es opcional.

IdP_Tenant

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El ID de inquilino de Azure AD para su aplicación de Amazon Redshift.

Este parámetro es necesario si la autenticación se realiza a través del servicio Azure AD.

IdP_Response_Timeout

• Valor predeterminado: 120

• Tipo de datos: entero

La cantidad de tiempo, en segundos, que espera el controlador en obtener la respuesta SAML del proveedor de identidad cuando se utilizan los servicios Azure AD o SAML a través de un complemento del navegador.

Este parámetro es opcional.

IniFile

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La ruta completa del archivo .ini, incluido el nombre del archivo. Por ejemplo:

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

Para obtener más información acerca del archivo .ini, consulte Creación de archivos de inicialización (.ini) para el controlador JDBC versión 2.1.

Este parámetro es opcional.

IniSection

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre de una sección del archivo .ini que contiene las opciones de configuración. Para obtener más información acerca del archivo .ini, consulte Creación de archivos de inicialización (.ini) para el controlador JDBC versión 2.1.

En el siguiente ejemplo, se especifica la sección [Prod] del archivo .ini:

IniSection="Prod"

Este parámetro es opcional.

isServerless

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción especifica si el host de punto de conexión de Amazon Redshift es una instancia sin servidor. El controlador intenta detectar este parámetro desde el host dado. Si utiliza un equilibrador de carga de red (NLB), el controlador no lo detectará, por lo que puede configurarlo aquí.

Este parámetro es opcional.

true

El host de punto de conexión de Amazon Redshift es una instancia sin servidor.

false

El host de punto de conexión de Amazon Redshift es un clúster aprovisionado.

Issuer_Url

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Apunta al punto de conexión de la instancia del servidor de AWS IAM Identity Center.

Este parámetro es necesario solo cuando en la autenticación se utiliza BrowserIdcAuthPlugin en la opción de configuración plugin_name.

Listen_Port

• Valor predeterminado: 7890

• Tipo de datos: entero

El puerto que utiliza el controlador para recibir la respuesta SAML del proveedor de identidades o el código de autorización cuando se utilizan los servicios SAML, Azure AD o AWS IAM Identity Center a través de un complemento del navegador.

Este parámetro es opcional.

Login_URL

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La dirección URL del recurso en el sitio web del proveedor de identidad en caso de que se utilicen los servicios Azure AD o SAML a través de un complemento del navegador.

Este parámetro es necesario si la autenticación se realiza con el servicio Azure AD o SAML a través de un complemento del navegador.

loginTimeout

• Valor predeterminado: 0

• Tipo de datos: entero

La cantidad de segundos que se debe esperar antes de que se agote el tiempo de espera cuando se conecta y se realiza la autenticación correspondiente al servidor. Si establecer la conexión toma más que este umbral de tiempo, se anula la conexión.

Cuando esta propiedad se establece en 0, las conexiones no agotan el tiempo de espera.

Este parámetro es opcional.

loginToRp

• Valor predeterminado: urn:amazon:webservices

• Tipo de datos: cadena

La relación de confianza para usuario autenticado que desea utilizar para el tipo de autenticación de AD FS.

Este parámetro es opcional.

LogLevel

• Valor predeterminado: 0

• Tipo de datos: entero

Utilice esta propiedad para activar o desactivar el registro en el controlador y especificar la cantidad de detalles incluidos en los archivos de registros.

Habilite el registro solo durante el tiempo suficiente para detectar un problema. El registro reduce el rendimiento y puede consumir una gran cantidad de espacio en el disco.

Este parámetro es opcional.

Establezca el parámetro en uno de los siguientes valores:

0

Desactive todos los registros.

1

Habilite el registro en el nivel FATAL, en el que se registran eventos de errores muy graves que harán que el controlador se anule.

2

Habilite el registro en el nivel ERROR, en el que se registran eventos de errores que aún podrían permitir que el controlador siga ejecutándose.

3

Habilite el registro en el nivel WARNING, en el que se registran los eventos que podrían dar lugar a un error si no se toman medidas al respecto.

4

Habilite el registro en el nivel INFO, en el que se registra la información general que describe el progreso del controlador.

5

Habilite el registro en el nivel DEBUG, en el que se registra información detallada que resulta de gran utilidad para la depuración del controlador.

6

Habilite el registro en el nivel TRACE, en el que se registra toda la actividad del controlador.

Cuando se habilita el registro, el controlador crea los siguientes archivos de registro en la ubicación que se especifica en la propiedad LogPath:

• redshift_jdbc.log: archivo que registra la actividad del controlador que no es específica de una conexión.

• redshift_jdbc_connection_[Number].log: archivo para cada conexión que se realiza a la base de datos, en el que [Number] es un número que permite la distinción de cada archivo de registro respecto a los demás. Este archivo registra la actividad del controlador específica de la conexión.

Si el valor de LogPath no es válido, el controlador envía la información registrada a la secuencia de salida estándar, System.out.

LogPath

• Valor predeterminado: el directorio de trabajo actual.

• Tipo de datos: cadena

La ruta completa a la carpeta en la que el controlador guarda los archivos de registros cuando la propiedad DSILogLevel está habilitada.

Para asegurarse de que la URL de conexión es compatible con todas las aplicaciones JDBC, se recomienda que evite las barras diagonales invertidas (\) en la ruta del archivo y escriba una nueva.

Este parámetro es opcional.

OverrideSchemaPatternType

• Valor predeterminado: nulo

• Tipo de datos: entero

Esta opción especifica si invalidar el tipo de consulta usada en las llamadas a getTables.

0

Consulta universal sin esquema

1

Consulta de esquema local

2

Consulta de esquema externo

Este parámetro es opcional.

Partner_SPID

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El valor del SPID (ID del proveedor de servicios) del socio que se utilizará cuando se autentique la conexión mediante el servicio PingFederate.

Este parámetro es opcional.

Password

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Cuando se conecta con la autenticación de IAM a través de un IDP, esta es la contraseña para el servidor IDP_Host. Cuando se utiliza la autenticación estándar, se puede utilizar esta opción como contraseña de la base de datos de Amazon Redshift en lugar de PWD.

Este parámetro es opcional.

Plugin_Name

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre de la clase completamente calificado que implementa un complemento de proveedor de credenciales específico.

Este parámetro es opcional.

Se admiten las siguientes opciones de proveedores:

• AdfsCredentialsProvider: Active Directory Federation Service

• AzureCredentialsProvider: servicio de Microsoft Azure Active Directory (AD)

• BasicJwtCredentialsProvider: servicio de JSON Web Tokens (JWT)

• BasicSamlCredentialsProvider: credenciales de lenguaje de marcado de aserción de seguridad (SAML) que puede utilizar con muchos proveedores de servicios de SAML.

• BrowserAzureCredentialsProvider: servicio del navegador de Microsoft Azure Active Directory (AD)

• BrowserAzureOAuth2CredentialsProvider: servicio del navegador de Microsoft Azure Active Directory (AD) para la autenticación nativa

• BrowserIdcAuthPlugin: complemento de autorización que utiliza AWS IAM Identity Center.

• BrowserSamlCredentialsProvider: navegador SAML para servicios de SAML, tales como Okta, Ping o ADFS

• IdpTokenAuthPlugin: complemento de autorización que acepta un token de AWS IAM Identity Center o un token de identidad basado en JSON (JWT) de OpenID Connect (OIDC) de cualquier proveedor de identidades web vinculado a AWS IAM Identity Center.

• OktaCredentialsProvider: servicio de Okta

• PingCredentialsProvider: servicio de PingFederate

PORT

• Valor predeterminado: nulo

• Tipo de datos: entero

El puerto del servidor de Amazon Redshift al que va a conectarse. Puede utilizar esta opción para especificar el puerto en la URL de conexión de JDBC.

Este parámetro es opcional.

Preferred_Role

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El rol de IAM que desea asumir durante la conexión a Amazon Redshift.

Este parámetro es opcional.

Perfil

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre del perfil que utilizará para la autenticación de IAM. Este perfil contiene cualquier propiedad de conexión adicional que no se haya especificado en la cadena de conexión.

Este parámetro es opcional.

PWD

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La contraseña correspondiente al nombre de usuario de Amazon Redshift que proporcionó mediante la propiedad UID.

Este parámetro es opcional.

queryGroup

• Valor predeterminado: nulo

• Tipo de datos: cadena

Esta opción permite asignar una consulta a una cola en tiempo de ejecución al asignar la consulta al grupo de consultas adecuado. El grupo de consultas se establece para la sesión. Todas las consultas que se ejecutan en la conexión corresponden a este grupo de consultas.

Este parámetro es opcional.

readOnly

• Valor predeterminado: false

• Tipos de datos: booleano

Esta propiedad determina si el controlador se encuentra en modo de solo lectura.

Este parámetro es opcional.

true

La conexión se encuentra en modo de solo lectura y no se puede escribir en el almacén de datos.

false

La conexión se encuentra en modo de solo lectura y se puede escribir en el almacén de datos.

Región

• Valor predeterminado: nulo

• Tipo de datos: cadena

Esta opción especifica la región de AWS en la que está ubicado el clúster. Si especifica la opción StsEndPoint, se omitirá la opción Region. La operación de la API GetClusterCredentials de Redshift también utiliza la opción Region.

Este parámetro es opcional.

reWriteBatchedInserts

• Valor predeterminado: false

• Tipos de datos: booleano

Esta opción permite optimizar la reescritura y la combinación de instrucciones INSERT compatibles en lotes.

Este parámetro es opcional.

reWriteBatchedInsertsSize

• Valor predeterminado: 128

• Tipo de datos: entero

Esta opción permite optimizar la reescritura y la combinación de instrucciones INSERT compatibles en lotes. Este valor debe aumentar a nivel exponencial por la potencia de 2.

Este parámetro es opcional.

roleArn

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre de recurso de Amazon (ARN) del rol. Asegúrese de indicar este parámetro cada vez que especifique BasicJwtCredentialsProvider para la opción Plugin_Name. Especifique el ARN en el siguiente formato:

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

Este parámetro es necesario siempre que se especifique BasicJwtCredentialsProvider para la opción Plugin_Name.

roleSessionName

• Valor predeterminado: jwt_redshift_session

• Tipo de datos: cadena

Un identificador para la sesión del rol asumido. Por lo general, se pasa el nombre o el identificador que se asocia con el usuario de su aplicación. Las credenciales de seguridad temporales que utiliza su aplicación se asocian a ese usuario. Puede indicar este parámetro cada vez que especifique BasicJwtCredentialsProvider para la opción Plugin_Name.

Este parámetro es opcional.

scope

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Una lista separada por espacios de los ámbitos a los que el usuario puede dar su consentimiento. Especifique este parámetro para que su aplicación de Microsoft Azure pueda obtener el consentimiento para las API a las que desee llamar. Puede especificar este parámetro cuando indique BrowserAzureOAuth2CredentialsProvider para la opción Plugin_Name.

Este parámetro es necesario para el complemento BrowserAzureOAuth2CredentialsProvider.

SecretAccessKey

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La clave de acceso de IAM para el usuario o el rol. Si esto se especifica, entonces también se debe especificar AccessKeyID. Si se pasa en la URL de JDBC, SecretAccessKey debe estar codificado en URL.

Este parámetro es opcional.

SessionToken

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El token de sesión temporal de IAM asociado con el rol de IAM que se está utilizando para la autenticación. Si se pasa en la URL de JDBC, el token de sesión de IAM temporal debe estar codificado en URL.

Este parámetro es opcional.

serverlessAcctId

• Valor predeterminado: nulo

• Tipo de datos: cadena

El ID de la cuenta de Amazon Redshift sin servidor. El controlador intenta detectar este parámetro desde el host dado. Si utiliza un equilibrador de carga de red (NLB), el controlador no lo detectará, por lo que puede configurarlo aquí.

Este parámetro es opcional.

serverlessWorkGroup

• Valor predeterminado: nulo

• Tipo de datos: cadena

El nombre del grupo de trabajo de Amazon Redshift sin servidor. El controlador intenta detectar este parámetro desde el host dado. Si utiliza un equilibrador de carga de red (NLB), el controlador no lo detectará, por lo que puede configurarlo aquí.

Este parámetro es opcional.

socketFactory

• Valor predeterminado: nulo

• Tipo de datos: cadena

Esta opción especifica una fábrica de sockets para la creación de sockets.

Este parámetro es opcional.

socketTimeout

• Valor predeterminado: 0

• Tipo de datos: entero

La cantidad de segundos que se debe esperar durante las operaciones de lectura del conector antes de que se agote el tiempo de espera. Si una operación dura más tiempo que este límite, se cierra la conexión. Cuando esta propiedad se establece en 0, la conexión no agota el tiempo de espera.

Este parámetro es opcional.

SSL

• Valor predeterminado: TRUE

• Tipo de datos: cadena

Utilice esta propiedad para activar o desactivar SSL para la conexión.

Este parámetro es opcional.

Puede especificar los valores siguientes:

TRUE

El controlador se conecta al servidor a través de SSL.

FALSO

El controlador se conecta al servidor sin utilizar SSL. Esta opción no es compatible con la autenticación de IAM.

Como alternativa, puede configurar la propiedad AuthMech.

SSL_Insecure

• Valor predeterminado: true

• Tipo de datos: cadena

Esta propiedad indica si se debe verificar el certificado de servidor de alojamientos de IDP.

Este parámetro es opcional.

Puede especificar los valores siguientes:

true

El controlador no verifica la autenticidad del certificado del servidor IDP.

false

El controlador verifica la autenticidad del certificado del servidor IDP.

SSLCert

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La ruta completa de un archivo .pem o .crt que contiene certificados de entidad de certificación de confianza adicionales destinados a verificar la instancia de servidor de Amazon Redshift cuando se utiliza SSL.

Este parámetro es obligatorio si se especifica SSLKey.

SSLFactory

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La fábrica SSL que se utilizará cuando se conecte al servidor a través de TLS o SSL sin emplear un certificado de servidor.

SSLKey

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La ruta completa del archivo .der que contiene el archivo de claves PKCS8 destinado a verificar los certificados especificados en SSLCert.

Este parámetro no es obligatorio si se especifica SSLCert.

SSLMode

• Valor predeterminado: verify-ca

• Tipo de datos: cadena

Utilice esta propiedad para especificar la forma en que el controlador valida los certificados cuando TLS o SSL está habilitado.

Este parámetro es opcional.

Puede especificar los valores siguientes:

verify-ca

El controlador verifica que el certificado proviene de una entidad de certificación (CA) de confianza.

verify-full

El controlador verifica que el certificado proviene de una entidad de certificación de confianza y que el nombre de alojamiento del certificado concuerda con el nombre de alojamiento especificado en la URL de conexión.

SSLPassword

• Valor predeterminado: 0

• Tipo de datos: cadena

La contraseña para el archivo de clave cifrado que se especifica en SSLKey.

Se requiere este parámetro si se especifica SSLKey y si se cifra el archivo clave.

SSLRootCert

• Valor predeterminado: ninguno

• Tipo de datos: cadena

La ruta completa de un archivo .pem o .crt que contiene el certificado de entidad de certificación raíz que permite verificar la instancia de servidor de Amazon Redshift cuando se utiliza SSL.

StsEndpointUrl

• Valor predeterminado: nulo

• Tipo de datos: cadena

Puede especificar un punto de conexión AWS Security Token Service (AWS STS). Si especifica la opción, se omitirá la opción Region. Solo puede especificar un protocolo seguro (HTTPS) para este punto de conexión.

tcpKeepAlive

• Valor predeterminado: TRUE

• Tipo de datos: cadena

Utilice esta propiedad para activar o desactivar keepalives de TCP.

Este parámetro es opcional.

Puede especificar los valores siguientes:

TRUE

El controlador utiliza keepalives de TCP para evitar que se agote el tiempo de espera en las conexiones.

FALSO

El controlador no utiliza keepalives de TCP.

token

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Un token de acceso proporcionado por AWS IAM Identity Center o un token web JSON (JWT) de OpenID Connect (OIDC) proporcionado por un proveedor de identidades web que esté vinculado con AWS IAM Identity Center. Su aplicación debe generar este token autenticando al usuario de su aplicación con AWS IAM Identity Center o con un proveedor de identidades vinculado con AWS IAM Identity Center.

Este parámetro funciona con IdpTokenAuthPlugin.

token_type

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Tipo de token que se utiliza en IdpTokenAuthPlugin.

Puede especificar los valores siguientes:

ACCESS_TOKEN

Introdúzcalo si utiliza un token de acceso proporcionado por AWS IAM Identity Center.

EXT_JWT

Introdúzcalo si utiliza un token web JSON (JWT) de OpenID Connect (OIDC) proporcionado por un proveedor de identidades basado en web que está integrado con AWS IAM Identity Center.

Este parámetro funciona con IdpTokenAuthPlugin.

UID

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El nombre de usuario de base de datos que utiliza para obtener acceso a la base de datos.

Este parámetro es obligatorio.

Usuario

• Valor predeterminado: ninguno

• Tipo de datos: cadena

Cuando se conecta mediante la autenticación de IAM a través de un IDP, este es el nombre de usuario que corresponde al servidor idp_host. Si se utiliza la autenticación estándar, se puede utilizar esta opción como nombre de usuario de la base de datos de Amazon Redshift.

Este parámetro es opcional.

webIdentityToken

• Valor predeterminado: ninguno

• Tipo de datos: cadena

El token de acceso de OAuth 2.1 o el token del ID de OpenID Connect proporcionado por el proveedor de identidad. Su aplicación debe obtener este token mediante la autenticación del usuario de su aplicación con un proveedor de identidad web. Asegúrese de indicar este parámetro cada vez que especifique BasicJwtCredentialsProvider para la opción Plugin_Name.

Este parámetro es necesario siempre que se especifique BasicJwtCredentialsProvider para la opción Plugin_Name.