Detalles de Conexión de Amazon Athena

Introducción

Versión del conector

Esta documentación se basa en la versión 21.0.8383 del conector.

Empezando

Compatibilidad con la versión de Amazon Athena

El conector Jitterbit para Amazon Athena se conecta con la API de servicios web de Amazon Athena.

Establecer una Conexión

Conexión a Amazon Athena

Especifique lo siguiente para conectarse a los datos:

• DataSource: el nombre de la fuente de datos de Amazon Athena a la que conectarse.
• Database: El nombre de la base de datos de Amazon Athena a la que conectarse.
• AWSRegion: establezca esto en la región donde se alojan sus datos de Amazon Athena.
• S3StagingDirectory: configure esto en una carpeta en S3 donde le gustaría almacenar los resultados de las consultas.

Si Database o DataSource no está configurado en la conexión, el conector se conecta a la fuente de datos predeterminada y la base de datos configurada en Amazon Athena.

Autenticación en Amazon Athena

Además de especificar la información de conexión básica requerida para todas las conexiones, debe elegir un método de autenticación de una de las opciones enumeradas a continuación.

Obtención de la Clave de Acceso

Para obtener las credenciales de un usuario de IAM, siga los pasos a continuación:

1. Inicie sesión en la consola de IAM.
2. En el panel de navegación, seleccione Usuarios.
3. Para crear o administrar las claves de acceso para un usuario, seleccione el usuario y luego seleccione la pestaña Credenciales de seguridad.

Para obtener las credenciales de su cuenta raíz de AWS, siga los pasos a continuación:

1. Inicie sesión en la consola de administración de AWS con las credenciales de su cuenta raíz.
2. Seleccione su nombre o número de cuenta y seleccione Mis credenciales de seguridad en el menú que se muestra.
3. Haga clic en Continuar con Credenciales de seguridad y expanda la sección Claves de acceso para administrar o crear claves de acceso a la cuenta raíz.

Autenticación con Credenciales Raíz

Para autenticarse usando las credenciales de la cuenta raíz, configure lo siguiente:

• AuthScheme: Establézcalo en AwsRootKeys.
• AWSAccessKey: La clave de acceso asociada con la cuenta raíz de AWS.
• AWSSecretKey: La clave secreta asociada con la cuenta raíz de AWS.

Nota: Amazon desaconseja el uso de este esquema de autenticación para cualquier cosa que no sea pruebas simples. Las credenciales de la cuenta raíz tienen todos los permisos del usuario, lo que hace que este sea el método de autenticación menos seguro.

Autenticación con Credenciales Temporales

Para autenticarse usando credenciales temporales, especifique lo siguiente:

• AuthScheme: Establézcalo en TemporaryCredentials.
• AWSAccessKey: La clave de acceso del usuario de IAM para el que asumirá el rol.
• AWSSecretKey: La clave secreta del usuario de IAM para el que asumirá el rol.
• AWSSessionToken: Su token de sesión de AWS. Esto se habrá proporcionado junto con sus credenciales temporales. Vea este enlace para más información.

El conector ahora puede solicitar recursos con los mismos permisos proporcionados por las credenciales a largo plazo (como las credenciales de usuario de IAM) durante la vida útil de las credenciales temporales.

Si también utiliza un rol de IAM para autenticarse, debe especificar además lo siguiente:

• AWSRoleARN: Especifique el ARN de función para la rol con la que desea autenticarse. Esto hará que el conector intente recuperar las credenciales para el rol especificado.
• AWSExternalId: Solo si se requiere cuando asume un rol en otra cuenta.

Autenticación Desde una Instancia EC2

Si está utilizando el conector de una instancia EC2 y tiene un rol de IAM asignado a la instancia, puede usar el rol de IAM para autenticarse. Para hacerlo, establezca las siguientes propiedades para autenticarse:

• AuthScheme: Establézcalo en AwsEC2Roles.

No especificar AWSAccessKey y AWSSecretKey porque el conector obtendrá automáticamente sus credenciales de rol de IAM y se autenticará con ellas.

Si también utiliza un rol de IAM para autenticarse, debe especificar además lo siguiente:

• AWSRoleARN: Especifique el ARN de función para la rol con la que desea autenticarse. Esto hará que el conector intente recuperar las credenciales para el rol especificado.
• AWSExternalId: Solo si se requiere cuando asume un rol en otra cuenta.

Soporte IMDSv2

El conector de Amazon Athena ahora es compatible con IMDSv2. A diferencia de IMDSv1, la nueva versión requiere un token de autenticación. Los Extremos y la respuesta son los mismos en ambas versiones. En IMDSv2, el conector de Amazon Athena primero intenta recuperar el token de metadatos de IMDSv2 y luego lo usa para llamar a los extremos de metadatos de AWS. Si no puede recuperar el token, el conector vuelve a IMDSv1.

Autenticación Como un Rol de AWS

En muchas situaciones, puede ser preferible utilizar un rol de IAM para la autenticación en lugar de las credenciales de seguridad directas de un usuario raíz de AWS.

Para autenticarse como un rol de AWS, configure lo siguiente:

• AuthScheme: Establézcalo en AwsIAMRoles.
• AWSRoleARN: Especifique el ARN de función para la rol con la que desea autenticarse. Esto hará que el conector intente recuperar las credenciales para el rol especificado.
• AWSExternalId: Solo si se requiere cuando asume un rol en otra cuenta.
• AWSAccessKey: La clave de acceso del usuario de IAM para el que asumirá el rol.
• AWSSecretKey: La clave secreta del usuario de IAM para el que asumirá el rol.

Nota: Es posible que no se utilicen roles al especificar AWSAccessKey y AWSSecretKey de un usuario raíz de AWS.

Autenticación con ADFS

Selecciona el AuthScheme a ADFS. Es necesario establecer las siguientes propiedades de conexión:

• User: Configure esto para el usuario de ADFS.
• Password: Establézcalo en la contraseña de ADFS para el usuario.
• SSOLoginURL: establezca esto en la URL de inicio de sesión utilizada por el proveedor de SSO.

A continuación se muestra una cadena de conexión de ejemplo:

AuthScheme=ADFS; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam:1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam:1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;

ADFS Integrado

El flujo integrado de ADFS indica que se está conectando con currently logged in Windows user credentials. Para usar el flujo integrado de ADFS, simplemente no especifique el User y Password, pero por lo demás siga los mismos pasos en la guía ADFS anterior.

Autenticación con Okta

Selecciona el AuthScheme a Okta. Las siguientes propiedades de conexión se utilizan para conectarse a Okta:

• User: Configure esto para el usuario de Okta.
• Password: establezca esto en la contraseña de Okta para el usuario.
• SSOLoginURL: establezca esto en la URL de inicio de sesión utilizada por el proveedor de SSO.

La siguiente SSOProperties son necesarios para autenticarse en Okta:

• APIToken (opcional): establezca esto en el token de API que el cliente creó a partir de la organización de Okta. Debe usarse al autenticar a un usuario a través de una aplicación confiable o un proxy que anula el contexto de solicitud del cliente de OKTA.
• MFAType (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Actualmente solo admitimos los siguientes tipos: OktaVerify, Correo y SMS.
• MFAPassCode (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Si está configurado como vacío/no válido, el controlador emitirá inicialmente un desafío de MFA que activará la plataforma para enviarle una contraseña de un solo uso a su dispositivo o correo, según el tipo de MFA configurado. Debe volver a emitir otra conexión en la que el valor de la contraseña de un solo uso recuperado se pase a la propiedad de conexión MFAPassCode.

La siguiente es una cadena de conexión de ejemplo:

AuthScheme=Okta; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam:1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam:1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;

Autenticación con PingFederate

Selecciona el AuthScheme a PingFederate. Es necesario establecer las siguientes propiedades de conexión:

• User: Configure esto para el usuario de PingFederate.
• Password: establezca esto en la contraseña de PingFederate para el usuario.
• SSOLoginURL: establezca esto en la URL de inicio de sesión utilizada por el proveedor de SSO.
• SSOExchangeUrl: El URI 'Identificador de servicio de socio' configurado en su instancia de servidor PingFederate en: SP Connections > SP Connection > WS-Trust > Protocol Settings. Esto debería identificar de forma única una conexión PingFederate SP, por lo que es una buena idea configurarlo en su 'AWS SSO ACS URL'. Puede encontrarlo en AWS SSO > Ajustes > Haga clic en 'Ver detalles' junto al campo Autenticación.

La siguiente SSOProperties son necesarios para autenticarse en PingFederate:

• AuthScheme (opcional): el esquema de autorización que se usará para el extremo IdP. Los valores permitidos para este IdP son Ninguno o Básico.

Además, puede utilizar los siguientes SSOProperties para configurar la autenticación SSL mutua para SSOLoginURL, el extremo de STS de WS-Trust:

• SSLClientCert
• SSLClientCertType
• SSLClientCertSubject
• SSLClientCertPassword

A continuación se muestra una cadena de conexión de ejemplo:

authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam:215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam:215338515180:role/SSOTest2;AWSRegion=Ireland;S3StagingDirectory=s3://somedirectory/staging;Database=athenadatabase;

Autenticación con MFA

Para los usuarios y roles que requieren autenticación multifactor, especifique lo siguiente para autenticarse:

• AuthScheme: Establézcalo en AwsMFA.
• CredentialsLocation: La ubicación del archivo de configuración donde se guardan las credenciales de MFA. Consulte la página Ubicación del archivo de credenciales en Propiedades de configuraciones avanzadas para obtener más información.
• MFASerialNumber: el número de serie del dispositivo MFA, si se está utilizando uno.
• MFAToken: El token temporal disponible desde su dispositivo MFA.

Si se está conectando a AWS (en lugar de estar ya conectado, como en una instancia EC2), debe especificar además lo siguiente:

• AWSAccessKey: La clave de acceso del usuario de IAM para el que se emitirá MFA.
• AWSSecretKey: La clave secreta del usuario de IAM a quien se emitirá MFA.

Si también utiliza un rol de IAM para autenticarse, debe especificar además lo siguiente:

• AWSRoleARN: Especifique el ARN de función para la rol con la que desea autenticarse. Esto hará que el conector intente recuperar las credenciales para el rol especificado mediante MFA.
• AWSExternalId: Solo si se requiere cuando asume un rol en otra cuenta.

Esto hará que el conector envíe las credenciales de MFA en una solicitud para recuperar las credenciales de autenticación temporales.

Tenga en cuenta que la duración de las credenciales temporales se puede controlar a través de TemporaryTokenDuration propiedad (por defecto 3600 segundos).

Autenticación con un Archivo de Credenciales

Puede usar un archivo de credenciales para autenticarse. Se utilizará cualquier configuración relacionada con la autenticación AccessKey/SecretKey, las credenciales temporales, la autenticación de rol o MFA. Para hacerlo, establezca las siguientes propiedades para autenticarse:

• AuthScheme: Establézcalo en AwsCredentialsFile.
• AWSCredentialsFile: establezca esto en la ubicación de su archivo de credenciales.
• AWSCredentialsFileProfile: Opcionalmente, establezca esto en el nombre del perfil que le gustaría usar del archivo de credenciales especificado. Si no se especifica, se utilizará el perfil con el nombre predeterminado.

Ver este enlace para más información.

Autenticación con Credenciales de AWS Cognito

Si desea utilizar el conector con un usuario registrado en un grupo de usuarios en AWS Cognito, configure las siguientes propiedades para autenticarse:

• AuthScheme: establezca esto en AwsCognitoSrp (recomendado). También puede utilizar AwsCognitoBasic.
• AWSCognitoRegion: establezca esto en la región del grupo de usuarios.
• AWSUserPoolId: Establézcalo en el Id. del grupo de usuarios.
• AWSUserPoolClientAppId: Establézcalo en el Id. de la aplicación del cliente del grupo de usuarios.
• AWSUserPoolClientAppSecret: establezca esto en el secreto del cliente del grupo de usuarios.
• AWSIdentityPoolId: establezca esto en el ID del grupo de identidades del grupo de identidades que está vinculado con el grupo de usuarios.
• User: establezca esto en el nombre de usuario del usuario registrado en el grupo de usuarios.
• Password: establezca esto en la contraseña del usuario registrado en el grupo de usuarios.

Autenticación con Microsoft Entra ID

Selecciona el AuthScheme a AzureAD. Las siguientes propiedades de conexión se utilizan para conectarse a Microsoft Entra ID:

Tenga en cuenta que esta configuración requiere dos aplicaciones AAD: la aplicación "Amazon Athena" utilizada para el inicio de sesión único y una aplicación "conector" independiente con permiso de suplantación de usuario en la aplicación "Amazon Athena". También debe especificar las propiedades de conexión de OAuth:

• OAuthClientId: el ID de la aplicación del conector, que se muestra en la sección Información general del registro de la aplicación.
• OAuthClientSecret: el valor secreto del cliente de la aplicación del conector. Azure AD muestra esto cuando crea un nuevo secreto de cliente.

La siguiente SSOProperties se utilizan para autenticarse en Microsoft Entra ID:

• Recurso: el identificador URI de la aplicación de Amazon Athena, que se muestra en la sección Descripción general del registro de la aplicación. En la mayoría de los casos, esta es la URL de su dominio personalizado de Amazon Athena.
• AzureTenant: El ID del arrendatario de Azure AD donde se registran las aplicaciones.

La siguiente es una cadena de conexión de ejemplo:

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;SSOProperties='Resource=';

Ajuste Fino del Acceso a los Datos

Personalización del Comportamiento de Amazon Athena

Siga los pasos a continuación para configurar los valores predeterminados del conector para consultar Amazon Athena.

Uso de QueryPassthrough

Amazon Athena admite un conjunto de consultas que no se especifican en el estándar SQL-92 habitual; para ejecutar estas consultas simplemente configure QueryPassthrough a verdadero. Esto pasará la consultar directamente a Amazon Athena sin analizarla internamente.

Cifrado de Resultados de Consultas en S3

Colocar EncryptionKey y EncryptionType si desea cifrar el conjunto de resultados almacenado en S3 después de la ejecución de la consultar.

Para cifrar los resultados almacenados en S3, siga los pasos a continuación:

1. Navegue a la Consola de Amazon Athena.
2. Haga clic en Configuración.
3. Habilite la opción Cifrar resultados de consulta.
4. Seleccione el tipo de cifrado y configure EncryptionType cuando se conecta.
5. Si seleccionó SSE-KMS o CSE-KMS, configure ambos EncryptionType y EncryptionKey: seleccione una clave de cifrado en el menú o haga clic en Crear clave KMS.

Actuación

Resultados de la Consulta de Limpieza

Amazon Athena almacena los resultados de cada consultar que ejecuta en archivos CSV en S3StagingDirectory; estos pueden acumular rápidamente una gran cantidad de espacio en Amazon S3. Puedes usar CleanQueryResults, habilitado por defecto, para limpiar estos archivos para cada consultar ejecutada.

Tenga en cuenta que este comportamiento agregará un impacto de rendimiento menor cuando desconecte la última conexión en un proceso.

Uso del Almacenamiento en Caché de Consultas de Athena

Tu configuras QueryCachingLevel para modificar el uso de los resultados de la consultar almacenados en S3StagingDirectory; tenga en cuenta que debe mantener la conexión abierta para beneficiarse de esta función. Esto es especialmente útil cuando se ejecuta una determinada consultar varias veces. Esto significa que Amazon Athena no volverá a escanear los mismos datos y simplemente usará los resultados de la ejecución anterior. Estos resultados se limpian en la cantidad de segundos especificados en QueryTolerance.

Tenga en cuenta que si no desconecta correctamente la conexión cuando QueryCachingLevel está configurado en la nube puede dar lugar a una gran cantidad de consultas guardadas en Athena. Para la mayoría de los casos de uso, ajuste QueryCachingLevel a Local debería ser suficiente.

Rendimiento de Ajuste Fino

Puedes usar el PageSize propiedad para optimizar el uso de su rendimiento aprovisionado, según el tamaño de sus elementos y el tamaño de página de 1000 MB de Amazon Athena. Establezca esta propiedad en el número de elementos a devolver.

Por lo general, un tamaño de página más pequeño reduce los picos en el rendimiento que provocan la limitación. Un tamaño de página más pequeño también inserta pausas entre solicitudes. Este intervalo iguala la distribución de solicitudes y permite que más solicitudes tengan éxito al evitar la limitación.

Permisos Mínimos de IAM

Recomendamos utilizar funciones predefinidas para los servicios en lugar de crear políticas de IAM personalizadas, pero si desea crear políticas personalizadas, utilice las funciones que se describen en la siguiente tabla. Tenga en cuenta que las políticas específicas requeridas por el controlador de Amazon Athena están sujetas a cambios en versiones futuras. Amazon Athena requiere como mínimo los siguientes permisos:

Consultas Federadas

Si utiliza consultas federadas, es decir, utiliza funciones de Lambda para obtener datos de otras fuentes, también necesita permisos de Lambda. Por ejemplo, para dar lambda:InvokeFunction permisos en un recurso con el nombre cloudwatchtest1 en el norte de Virginia:

{
"Effect": "Allow",
"Action": [
"lambda:InvokeFunction"
],
"Resource": [
"arn:aws:lambda:us-east-1:987654321098:function:cloudwatchtest1"
]
}

Solo el permiso Lambda es opcional. Todos los demás permisos son necesarios para hacer una simple SELECCIÓN con el controlador.

Características Avanzadas

Esta sección detalla una selección de funciones avanzadas del conector de Amazon Athena.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario

El conector Jitterbit para Amazon Athena le permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Usando un Archivo de Configuración

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM [AwsDataCatalog].[sampledb].Customers WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Vistas Definidas por el Usuario

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL

Personalización de la Configuración SSL

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos

Procedimientos almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados* son interfaces similares a funciones para Amazon Athena. Se pueden utilizar para buscar, actualizar y modificar información en Amazon Athena.

Tablas de sistema

Las tablas del sistema son un conjunto de tablas proporcionado que contienen metadatos del controlador. Puede usar las tablas del sistema para acceder a la información del esquema, la funcionalidad de la fuente de datos y las estadísticas de operación lote.

Objetos de Modelado

Conector Jitterbit para el Modelo de Datos de Amazon Athena

El conector extrae dinámicamente toda la información de esquema relevante de Amazon Athena a través de la API REST.

Descubriendo Esquemas

De forma predeterminada, todas las entidades de Amazon Athena se expondrán como vistas. Sin embargo, el conector también es capaz de dividir los tipos de objetos en los siguientes tipos de la API de Amazon Athena:

• MESA
• VISTA
• EXTERNAL_TABLE
• MANAGED_TABLE
• VISTA_VIRTUAL

Puede habilitar esta funcionalidad configurando MetadataDiscoveryMethod a Glue. Este método requerirá que agregue también los perfiles de IAM necesarios para el usuario.

Como alternativa, puede utilizar el método de descubrimiento de Athena, aunque este método es más lento.

• MetadataDiscoveryMethod: Establézcalo en Athena.
• IncludeTableTypes: Establézcalo en True.

Tenga en cuenta que, si bien el conector puede dividir los objetos de Amazon Athena en estos tipos, todos se consideran read-only. Vuelva a conectarse para cargar cualquier cambio en los metadatos, como columnas agregadas o eliminadas o cambios en el tipo de datos.

Procedimientos Almacenados

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Conector Jitterbit para Procedimientos Almacenados de Amazon Athena

CrearEsquema

Crea un archivo de esquema para la tabla o vista especificada.

Aporte

Columnas del Conjunto de Resultados

Obtener Token de Acceso de OAuth

Si usa una aplicación de Windows, establezca Authmode en App. Si usa una aplicación web, establezca Authmode en Web y especifique el Verificador obtenido por GetOAuthAuthorizationUrl.

Aporte

Columnas del Conjunto de Resultados

Obtener URL de Autorización de OAuth

Obtiene la URL de autorización.

Aporte

Columnas del Conjunto de Resultados

RefreshOAuthAccessToken

Actualiza el token de OAuth o el ID de sesión después de que la sesión haya expirado. Tu aplicación de OAuth debe tener activado el ámbito refresh_token.

Aporte

Columnas del Conjunto de Resultados

Tablas del Sistema

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema

Las siguientes tablas devuelven metadatos de la base de datos para Amazon Athena:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

Tablas de Fuentes de Datos

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

• sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
• sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consultas

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

• identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs

Columnas

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas

Sys_tablecolumns

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla [AwsDataCatalog].[sampledb].Customers:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers' AND CatalogName='AwsDataCatalog' AND SchemaName='sampledb'

Columnas

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columnas

Sys_keycolumns

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla [AwsDataCatalog].[sampledb].Customers:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers' AND CatalogName='AwsDataCatalog' AND SchemaName='sampledb'

Columnas

Sys_foreignkeys

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columnas

Sys_indexes

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columnas

Sys_connection_props

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:amazonathena:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columnas

Sys_sqlinfo

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas

Sys_identidad

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity

Columnas

Propiedades de Configuraciones Avanzadas

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

Autenticación

Conexión

Autenticación de AWS

SSO

OAuth

SSL

Esquema

Misceláneas

Autenticación

Esta sección proporciona una lista completa de las propiedades de autenticación que puede configurar.

AthenaVPCEndpoint

Su Extremo de la VPC de Athena. Anulará el extremo final athena.{region}.amazonaws.com predeterminado.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Su Extremo de la VPC de Athena. Anulará el extremo final athena.{region}.amazonaws.com predeterminado.

S3StageDirectory

Especifica la ubicación que utilizará Amazon Athena para almacenar los resultados de una consultar.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifica la ubicación que utilizará Amazon Athena para almacenar los resultados de una consultar. Esta carpeta puede ocupar espacio a lo largo del tiempo y es posible que desee limpiarla manualmente si CleanQueryResults no está habilitado.

Tipo de Cifrado

Especifica la opción de cifrado para los resultados de la consultar en Athena.

Valores Posibles

None, SSE_S3, SSE_KMS, CSE_KMS

Tipo de Datos

string

Valor por Defecto

"None"

Observaciones

Especifica la opción de cifrado para los resultados de la consultar en Athena. Esta opción es obligatoria si ha configurado Amazon Athena para cifrar los resultados de las consultar; Colocar EncryptionType y Clave de cifrado si desea cifrar el conjunto de resultados almacenado en S3 después de la ejecución de la consultar. Tenga en cuenta que configurar estas propiedades no cifrar el conjunto de resultados en S3StagingDirectory.

Para cifrar los resultados de la consultar de Amazon Athena, siga los siguientes pasos:

1. Navegue a la Consola de Amazon Athena.
2. Haga clic en Configuración.
3. Habilite la opción Cifrar resultados de consulta.
4. Seleccione el tipo de cifrado.
5. Si seleccionó SSE-KMS o CSE-KMS, seleccione una clave de cifrado en el menú o haga clic en Crear clave KMS. Establecer Clave de cifrado además de EncryptionType cuando se conecta.

Clave de Encriptación

Especifica la clave de cifrado al cifrar los resultados almacenados en S3.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifica la clave de cifrado al cifrar los resultados almacenados en S3. Esta opción es necesaria si el EncryptionType se establece en SSE_KMS o CSE_KMS.

Establecer Tipo de cifrado y EncryptionKey si desea cifrar el conjunto de resultados almacenado en S3 después de la ejecución de la consultar. Tenga en cuenta que esto no cifrar el conjunto de resultados en S3StagingDirectory.

Habilitación del Cifrado

Para habilitar el cifrado de los resultados almacenados en S3, consulte Ajuste preciso del acceso a datos.

Obtención de una Clave de Cifrado

Puede crear una clave cuando activa el cifrado. O bien, cree una clave en la consola de IAM: haga clic en Claves de cifrado, seleccione una región y luego haga clic en Crear clave. Para obtener la clave, inicie sesión en la consola de administración de AWS y haga clic en Servicios -> IAM -> Claves de cifrado -> Crear clave.

Base de Datos

El nombre de la base de datos de Athena.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La base de datos a la que conectarse al consultar Athena; si no se establece, se utiliza la base de datos predeterminada establecida en Amazon Athena.

Fuente de Datos

El nombre de la fuente de datos de Athena.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La fuente de datos a la que conectarse cuando se consulta a Athena; si no se establece el valor predeterminado, AwsDataCatalog, se utiliza el origen de datos establecido en Amazon Athena.

Conexión

Esta sección proporciona una lista completa de las propiedades de conexión que puede configurar.

CrossAccountId

El ID de la cuenta que se usará al recuperar metadatos de Glue. El valor predeterminado es el ID de la cuenta actual.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Cuando la propiedad MetadataDiscoveryMethod se ha establecido en 'Glue', entonces el usuario puede especificar una ID de cuenta cruzada a la que tiene permisos para acceder, y esta cuenta se usará para recuperar metadatos. Ver más información aquí: https://docs.aws.amazon.com/glue/latest/dg/cross-account-access.html

Límite de Carga Simple

Esta configuración especifica el umbral, en bytes, por encima del cual el proveedor elegirá realizar una carga de varias partes en lugar de cargar todo en una sola solicitud.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta configuración especifica el umbral, en bytes, por encima del cual el conector elegirá realizar una carga de varias partes en lugar de cargar todo en una sola solicitud.

Autenticación de AWS

Esta sección proporciona una lista completa de las propiedades de autenticación de AWS que puede configurar.

AuthScheme

El esquema utilizado para la autenticación. Las entradas aceptadas son: Auto, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, ADFS, Okta, PingFederate, AwsCredentialsFile, AwsCognitoBasic, AwsCognitoSrp.

Valores Posibles

Auto, ADFS, AwsRootKeys, AwsIAMRoles, AwsEC2Roles, AwsMFA, AwsCredentialsFile, Okta, TemporaryCredentials, PingFederate, AwsCognitoBasic, AwsCognitoSrp, AzureAD

Tipo de Datos

string

Valor por Defecto

"Auto"

Observaciones

Utilice las siguientes opciones para seleccionar su esquema de autenticación:

• Automático: configure esto para que el conector intente resolver automáticamente el esquema de autenticación adecuado para usar en función de las otras propiedades de conexión especificadas.
• TemporalCredentials: configure esto para aprovechar las credenciales de seguridad temporales junto con un token de sesión para conectarse.
• AwsRootKeys: configure esto para usar la clave de acceso y el secreto del usuario raíz. Útil para pruebas rápidas, pero se recomienda que los casos de uso de producción usen algo con permisos limitados.
• AwsIAMRoles: Configure para usar roles de IAM para la conexión.
• AwsEC2Roles: configure esto para usar automáticamente los roles de IAM asignados a la máquina EC2 en la que se está ejecutando Jitterbit Connector para Amazon Athena.
• AwsMFA: configurado para usar la autenticación de múltiples factores.
• Okta: configurado para usar una conexión de inicio de sesión único con OKTA como proveedor de identidad.
• ADFS: configure para usar una conexión de inicio de sesión único con ADFS como proveedor de identidad.
• PingFederate: configurado para usar una conexión de inicio de sesión único con PingFederate como proveedor de identidad.
• AwsCredentialsFile: configurado para usar un archivo de credenciales para la autenticación.
• AwsCognitoSrp: configurado para usar la autenticación basada en Cognito. Se recomienda esto sobre AwsCognitoBasic porque esta opción NO envía la contraseña al servidor para la autenticación, sino que utiliza el protocolo SRP.
• AwsCognitoBasic: configurado para usar la autenticación basada en Cognito.

Clave de Acceso de AWS

Su clave de acceso a la cuenta de AWS. Se puede acceder a este valor desde su página de credenciales de seguridad de AWS.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Su clave de acceso a la cuenta de AWS. Se puede acceder a este valor desde su página de credenciales de seguridad de AWS:

1. Inicie sesión en la consola de administración de AWS con las credenciales de su cuenta raíz.
2. Seleccione su nombre o número de cuenta y seleccione Mis credenciales de seguridad en el menú que se muestra.
3. Haga clic en Continuar con Credenciales de seguridad y expanda la sección Claves de acceso para administrar o crear claves de acceso a la cuenta raíz.

AWSSecretKey

La clave secreta de su cuenta de AWS. Se puede acceder a este valor desde su página de credenciales de seguridad de AWS.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La clave secreta de su cuenta de AWS. Se puede acceder a este valor desde su página de credenciales de seguridad de AWS:

1. Inicie sesión en la consola de administración de AWS con las credenciales de su cuenta raíz.
2. Seleccione su nombre o número de cuenta y seleccione Mis credenciales de seguridad en el menú que se muestra.
3. Haga clic en Continuar con Credenciales de seguridad y expanda la sección Claves de acceso para administrar o crear claves de acceso a la cuenta raíz.

AWSRoleARN

El nombre de recurso de Amazon del rol que se usará al autenticarse.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Cuando se autentica fuera de AWS, es común usar un rol para la autenticación en lugar de las credenciales de su cuenta de AWS directa. Entrando al AWSRoleARN hará que Jitterbit Connector for Amazon Athena realice una autenticación basada en rol en lugar de utilizar AWSAccessKey y AWSSecretKey directamente. La AWSAccessKey y AWSSecretKey aún debe especificarse para realizar esta autenticación. No puede utilizar las credenciales de un usuario raíz de AWS al configurar RoleARN. La AWSAccessKey y AWSSecretKey deben ser los de un usuario de IAM.

AWSPrincipalARN

El ARN del proveedor de identidad SAML en su cuenta de AWS.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El ARN del proveedor de identidad SAML en su cuenta de AWS.

Región de AWS

La región de alojamiento de sus Amazon Web Services.

Valores Posibles

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

Tipo de Datos

string

Valor por Defecto

"NORTHERNVIRGINIA"

Observaciones

La región de alojamiento de sus Amazon Web Services. Los valores disponibles son OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEÚL, SINGAPUR, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRLANDA, LONDRES, MILÁN, PARÍS, ESTOCOLMO, BAHREIN, SAOPAULO, GOVCLOUDEAST y GOVCLOUDWEST.

AWSCredentialsFile

La ruta al archivo de credenciales de AWS que se utilizará para la autenticación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La ruta al archivo de credenciales de AWS que se utilizará para la autenticación. Ver https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html para más información.

AWSCredentialsFileProfile

El nombre del perfil que se utilizará del AWSCredentialsFile proporcionado.

Tipo de Datos

string

Valor por Defecto

"default"

Observaciones

El nombre del perfil que se utilizará del AWSCredentialsFile proporcionado. Ver https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html para más información.

Token de Sesión de AWS

Su token de sesión de AWS.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Su token de sesión de AWS. Este valor se puede recuperar de diferentes maneras. Vea este enlace para más información.

AWSExternalId

Un identificador único que puede ser necesario cuando asume un rol en otra cuenta.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Un identificador único que puede ser necesario cuando asume un rol en otra cuenta.

MFASerialNumber

El número de serie del dispositivo MFA, si se está utilizando uno.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Puede encontrar el dispositivo para un usuario de IAM yendo a la Management Console de AWS y viendo las credenciales de seguridad del usuario. Para dispositivos virtuales, en realidad es un nombre de recurso de Amazon (como arn:aws:iam:123456789012:mfa/user).

Token MFA

El token temporal disponible desde su dispositivo MFA.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si se requiere MFA, este valor se utilizará junto con el MFASerialNumber para recuperar credenciales temporales para iniciar sesión. Las credenciales temporales disponibles de AWS solo durarán hasta 1 hora de forma predeterminada (consulte TemporaryTokenDuration). Una vez que se acabe el tiempo, la conexión debe actualizarse para especificar un nuevo token MFA para que se puedan obtener nuevas credenciales.

Duración del Token Temporal

La cantidad de tiempo (en segundos) que durará un token temporal.

Tipo de Datos

string

Valor por Defecto

"3600"

Observaciones

Los tokens temporales se utilizan tanto con MFA como con la autenticación basada en roles. Los tokens temporales eventualmente expirarán, momento en el cual se debe obtener un nuevo token temporal. Para situaciones en las que no se usa MFA, esto no es gran cosa. Jitterbit Connector para Amazon Athena solicitará internamente un nuevo token temporal una vez que el token temporal haya caducado.

Sin embargo, para la conexión requerida por MFA, un nuevo MFAToken debe especificarse en la conexión para recuperar un nuevo token temporal. Este es un problema más intrusivo ya que requiere una actualización de la conexión por parte del usuario. El máximo y mínimo que se puede especificar dependerá en gran medida de la conexión que se utilice.

Para la autenticación basada en roles, la duración mínima es de 900 segundos (15 minutos) mientras que la máxima es de 3600 (1 hora). Incluso si se usa MFA con autenticación basada en rol, 3600 sigue siendo el máximo.

Para la autenticación MFA por sí sola (usando un usuario de IAM o usuario raíz), el mínimo es 900 segundos (15 minutos), el máximo es 129600 (36 horas).

Región de AWSCognito

La región de alojamiento de AWS Cognito.

Valores Posibles

OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEOUL, SINGAPORE, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRELAND, LONDON, MILAN, PARIS, STOCKHOLM, BAHRAIN, SAOPAULO, GOVCLOUDEAST, GOVCLOUDWEST

Tipo de Datos

string

Valor por Defecto

"NORTHERNVIRGINIA"

Observaciones

La región de alojamiento de AWS Cognito. Los valores disponibles son OHIO, NORTHERNVIRGINIA, NORTHERNCALIFORNIA, OREGON, CAPETOWN, HONGKONG, MUMBAI, OSAKA, SEÚL, SINGAPUR, SYDNEY, TOKYO, CENTRAL, BEIJING, NINGXIA, FRANKFURT, IRLANDA, LONDRES, MILÁN, PARÍS, ESTOCOLMO, BAHREIN, SAOPAULO, GOVCLOUDEAST y GOVCLOUDWEST.

AWSUserPoolId

El ID del grupo de usuarios.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Puede encontrar esto en AWS Cognito -> Administrar grupos de usuarios -> seleccione su grupo de usuarios -> Configuración general -> Identificación del grupo.

AWSUserPoolClientAppId

El ID de la aplicación del cliente del grupo de usuarios.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Puede encontrar esto en AWS Cognito -> Administrar grupos de identidades -> seleccione su grupo de usuarios -> Configuración general -> Clientes de aplicaciones -> ID de cliente de la aplicación.

AWSUserPoolClientAppSecret

Opcional. El secreto de la aplicación del cliente del grupo de usuarios.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Puede encontrar esto en AWS Cognito -> Administrar grupos de identidades -> seleccione su grupo de usuarios -> Configuración general -> Clientes de aplicaciones -> Secreto del cliente de la aplicación.

AWSIdentityPoolId

El ID del grupo de identidades.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Puede encontrar esto en AWS Cognito -> Administrar grupos de identidades -> seleccione su conjunto de identidades -> Editar grupo de identidades -> ID del grupo de identidades

Inicio de Sesión Único

Esta sección proporciona una lista completa de las propiedades de SSO que puede configurar.

Usuario

El usuario IDP utilizado para autenticar el IDP a través de SSO.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Junto con Contraseña, este campo se usa para autenticarse en conexiones SSO contra el servidor de Amazon Athena.

Contraseña

La contraseña utilizada para autenticar al usuario IDP a través de SSO.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El usuario y Password se usan juntos en conexiones SSO para autenticarse con el servidor.

SSOloginURL

La URL de inicio de sesión del proveedor de identidad.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La URL de inicio de sesión del proveedor de identidad.

Propiedades de SSO

Se requieren propiedades adicionales para conectarse al proveedor de identidad en una lista separada por punto y coma.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Se requieren propiedades adicionales para conectarse al proveedor de identidad en una lista separada por punto y coma. SSOProperties se utiliza junto con AWSRoleARN y AWSPrincipalARN. La siguiente sección proporciona un ejemplo usando el proveedor de identidad OKTA.

Autenticación con ADFS

Configure el AuthScheme a ADFS. Es necesario establecer las siguientes propiedades de conexión:

• Usuario: establezca esto para el usuario de ADFS.
• Contraseña: Establezca esto en la contraseña de ADFS para el usuario.
• URL de inicio de sesión de SSO: configúrelo en la URL de inicio de sesión utilizada por el proveedor de SSO.

A continuación se muestra una cadena de conexión de ejemplo:

AuthScheme=ADFS; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam:1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam:1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;

ADFS Integrado

El flujo integrado de ADFS indica que se está conectando con currently logged in Windows user credentials. Para utilizar el flujo integrado de ADFS, simplemente no especifique el Usuario y contraseña, pero de lo contrario, siga los mismos pasos en la guía ADFS anterior.

Autenticación con Okta

Configure el AuthScheme a Okta. Las siguientes propiedades de conexión se utilizan para conectarse a Okta:

• Usuario: Configure esto para el usuario de Okta.
• Contraseña: Establézcalo en la contraseña de Okta para el usuario.
• URL de inicio de sesión de SSO: configúrelo en la URL de inicio de sesión utilizada por el proveedor de SSO.

La siguiente SSOProperties son necesarios para autenticarse en Okta:

• APIToken (opcional): establezca esto en el token de API que el cliente creó a partir de la organización de Okta. Debe usarse al autenticar a un usuario a través de una aplicación confiable o un proxy que anula el contexto de solicitud del cliente de OKTA.
• MFAType (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Actualmente solo admitimos los siguientes tipos: OktaVerify, Correo y SMS.
• MFAPassCode (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Si está configurado como vacío/no válido, el controlador emitirá inicialmente un desafío de MFA que activará la plataforma para enviarle una contraseña de un solo uso a su dispositivo o correo, según el tipo de MFA configurado. Debe volver a emitir otra conexión en la que el valor de la contraseña de un solo uso recuperado se pase a la propiedad de conexión MFAPassCode.

La siguiente es una cadena de conexión de ejemplo:

AuthScheme=Okta; AWSRegion=Ireland; Database=sampledb; User=user@cdata.com; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam:1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam:1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;

SSOExchangeUrl

La URL utilizada para consumir la respuesta SAML e intercambiarla con credenciales específicas de Amazon Athena.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Jitterbit Connector para Amazon Athena utilizará la URL especificada aquí para consumir una respuesta SAML y recuperar credenciales específicas de Amazon Athena. Las credenciales recuperadas son la pieza final durante la conexión SSO que se utilizan para comunicarse con Amazon Athena.

OAuth

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Iniciar OAuth

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles

OFF, GETANDREFRESH, REFRESH

Tipo de Datos

string

Valor por Defecto

"OFF"

Observaciones

Las siguientes opciones están disponibles:

1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth

El token de acceso para conectarse mediante OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

URL de Devolución de Llamada

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

OAuthVerifier

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

SSL

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

SSLServerCert

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Ubicación

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos

string

Valor por Defecto

"%APPDATA%\\\AmazonAthena Data Provider\\Schema"

Observaciones

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\AmazonAthena Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Esquemas Navegables

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Resultados de la Consulta Limpia

Amazon Athena genera archivos de caché con cada consultar, en la carpeta especificada en S3StagingDirectory. CleanQueryResults especifica si estos archivos deben eliminarse una vez que se cierra la conexión.

Tipo de Datos

bool

Valor por Defecto

true

Observaciones

Amazon Athena almacena los resultados de cada consultar que ejecuta como un archivo CSV en S3StagingDirectory. Estos archivos CSV pueden acumular rápidamente mucho espacio en Amazon S3.

Puedes usar CleanQueryResults, habilitado por defecto, para limpiar estos archivos para cada consultar ejecutada. Tenga en cuenta que este comportamiento agregará un impacto de rendimiento menor cuando desconecte la última conexión en un proceso.

Ver También

Consulte Ajuste preciso del acceso a datos para obtener más información sobre cómo configurar el almacenamiento en caché de consultar de Athena.

Activar Modo FIPS

Un valor booleano que indica si se deben habilitar las URLs de FIPS.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

FIPS o el Estándar federal de procesamiento de información son extremos separados en Amazon que pueden ser necesarios para ciertas organizaciones gubernamentales. Colocar EnableFIPSMode a verdadero para cambiar al uso de estos extremos. Ver más información aquí: https://aws.amazon.com/compliance/fips/.

Incluir Tipos de Tabla

Si se establece en verdadero, el proveedor consultar los tipos de tablas individuales.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Si se establece en verdadero, el conector consultar a Athena o Glue sobre los tipos de tablas individuales. Método de descubrimiento de metadatos alterna el servicio que se utilizará para recuperar los tipos.

Tamaño Máximo de Columna

El tamaño máximo de columna.

Tipo de Datos

int

Valor por Defecto

255

Observaciones

Algunas herramientas restringen el tamaño más grande de una columna o el tamaño total de todas las columnas seleccionadas. Puede configurar el MaximumColumnSize para superar estas restricciones basadas en esquemas. El conector no informará que ninguna columna sea más grande que MaximumColumnSize.

Establecer un MaximumColumnSize de cero para eliminar los límites en el tamaño de la columna, como se muestra en el siguiente ejemplo:

Filas Máximas

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos

int

Valor por Defecto

-1

Observaciones

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

MetadataDiscoveryMethod

API que se usará para recuperar los metadatos de Amazon Athena.

Valores Posibles

Glue, Athena

Tipo de Datos

string

Valor por Defecto

"Athena"

Observaciones

API que se usará para recuperar los metadatos de Amazon Athena.

Otro

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo

Tamaño de Página

El número de resultados que se devolverán por página de datos recuperados de Amazon Athena.

Tipo de Datos

string

Valor por Defecto

"1000"

Observaciones

El número de resultados que se devolverán por página de datos recuperados de Amazon Athena. El valor máximo permitido es 1000. Consulte Ajuste preciso del acceso a datos para obtener más información sobre la configuración de esta propiedad para evitar la limitación de solicitudes.

Intervalo de Votación

Esto determina el intervalo de sondeo en milisegundos para verificar si el resultado está listo para ser recuperado.

Tipo de Datos

string

Valor por Defecto

"100"

Observaciones

Esta propiedad determina cuánto tiempo esperar entre comprobar si los resultados de la consulta están listos o no. Los conjuntos de resultados muy grandes o las consultas complejas pueden tardar más en procesarse, y un intervalo de sondeo bajo puede dar lugar a que se realicen muchas solicitudes innecesarias para comprobar el estado de la consultar.

Pseudocolumnas

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

QueryCachingLevel

Modifica el uso de los resultados de la consultar almacenados en S3StagingDirectory. Amazon Athena no volverá a analizar las consultas almacenadas en caché hasta que haya transcurrido la cantidad de segundos especificada en QueryTolerance.

Valores Posibles

None, Local, Cloud

Tipo de Datos

string

Valor por Defecto

"Local"

Observaciones

Modifica el uso de los resultados de la consultar almacenados en S3StagingDirectory. Amazon Athena no volverá a analizar las consultas almacenadas en caché hasta que transcurran los segundos especificados en QueryTolerance ha pasado. Las mayúsculas y minúsculas de las consultas deben coincidir exactamente para desencadenar el comportamiento, que se explica a continuación:

Transferencia de Consulta

Esta opción pasa la consultar al servidor de Amazon Athena tal cual.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Cuando se configura, las consultas se transfieren directamente a Amazon Athena.

Tiempo Vencido de Consulta

El tiempo de espera en segundos para las solicitudes emitidas por el proveedor para descargar grandes conjuntos de resultados.

Tipo de Datos

int

Valor por Defecto

1800

Observaciones

Si el QueryTimeout la propiedad se establece en 0, las operaciones no se agotarán; en su lugar, se ejecutarán hasta que se completen correctamente o encuentren una condición de error. Esta propiedad es distinta de Tiempo de espera que se aplica a operaciones HTTP individuales mientras que QueryTimeout se aplica al tiempo de ejecución de la operación en su conjunto.

Si QueryTimeout caduca y la solicitud no ha terminado de procesarse, el conector genera una condición de error.

QueryTolerance

Especifica la cantidad de tiempo en segundos para las consultas en caché si QueryCachingLevel no está establecido en Ninguno.

Tipo de Datos

string

Valor por Defecto

"600"

Observaciones

Especifica la cantidad de tiempo en segundos que las consultas almacenarán en caché si QueryCachingLevel no está establecido en Ninguno. No se aceptan valores inferiores a 1.

ShowS3Filepath

Si exponer o no la columna _S3Path para las tablas de Amazon Athena.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

La columna _S3Path hace referencia a la columna $path de Amazon Athena, que devuelve la ruta del archivo de origen de Amazon S3 para cada fila de la salida.

El conector expondrá la columna _S3Path para cada tabla, solo si esta propiedad de conexión se establece en TRUE.

SkipHeaderLineCount

Especifica el número de filas de encabezado que se omitirán para las consultas SELECT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifica el número de filas de encabezado que se omitirán para las consultas SELECT. Esto se usa más comúnmente para las tablas de Athena que apuntan a una fuente de datos CSV. Si la fuente de datos CSV tiene encabezados, establezca SkipHeaderLineCount a 1.

Si ha utilizado AWS Glue para generar tablas en Athena, puede encontrarlo en la propiedad de tabla "skip. encabezado.line.count".

Se Acabó el Tiempo

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos

int

Valor por Defecto

60

Observaciones

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.

Grupo de Trabajo

Grupo de trabajo de las consultas ejecutadas.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Grupo de trabajo de las consultas ejecutadas.