Etapa 3: criar a integração de API para AWS no Snowflake

Este tópico fornece instruções para a criação de um objeto de integração de API no Snowflake para trabalhar com seu serviço de proxy (ou seja, Amazon API Gateway). As instruções são as mesmas independentemente de você estar usando o Console de gerenciamento ou o modelo CloudFormation.

Neste tópico:

Etapa anterior

Console de gerenciamento da AWS:

Etapa 2: criar o serviço de proxy (Amazon API Gateway) no console de gerenciamento da AWS

Modelo do AWS CloudFormation:

Etapa 2: registrar a URL do Amazon API Gateway e o ARN da nova função IAM

Pré-requisitos

Você precisa das seguintes informações para criar a integração de API para a AWS no Snowflake:

  • O New IAM Role ARN (da sua planilha de rastreamento).

  • O Resource Invocation URL (da sua planilha de rastreamento).

Criar o objeto de integração de API

  1. Abra uma sessão do Snowflake, normalmente uma sessão de interface da Web do Snowflake.

  2. Use uma função do Snowflake com privilégios ACCOUNTADMIN ou o privilégio CREATE INTEGRATION, por exemplo:

    use role <has_accountadmin_privileges>;
    
    Copy
  3. Digite o comando CREATE API INTEGRATION para criar uma integração de API. O comando deve ser semelhante ao seguinte:

    CREATE OR REPLACE API INTEGRATION my_api_integration_01
      api_provider = aws_api_gateway
      api_aws_role_arn = '<new_IAM_role_ARN>'
      api_allowed_prefixes = ('https://')
      enabled = true;
    
    Copy

    Personalize o comando:

    • A cláusula api_provider deve ser definida com base no tipo de ponto de extremidade:

      • Se você estiver usando um ponto de extremidade privado, a cláusula api_provider deve ser definida como aws_private_api_gateway.

      • Se você estiver usando um ponto de extremidade GovCloud do governo dos EUA, a cláusula api_provider deve ser definida como aws_gov_api_gateway ou aws_gov_private_api_gateway.

      • Para a maioria dos outros usuários, a cláusula api_provider deve ser definida como aws_api_gateway.

    • O <new_IAM_role_ARN> deve ser o valor no campo New IAM Role ARN da planilha de rastreamento.

    • O campo api_allowed_prefixes deve conter a URL da invocação de recursos que você registrou anteriormente.

    Abaixo está um exemplo de uma instrução CREATE API INTEGRATION completa:

    create or replace api integration demonstration_external_api_integration_01
        api_provider=aws_api_gateway
        api_aws_role_arn='arn:aws:iam::123456789012:role/my_cloud_account_role'
        api_allowed_prefixes=('https://xyz.execute-api.us-west-2.amazonaws.com/production/')
        enabled=true;
    
    Copy
  4. No campo da planilha de rastreamento intitulado API Integration Name, registre o nome da integração de API que você criou. Você precisará do nome da integração de API quando executar o comando CREATE EXTERNAL FUNCTION posteriormente.

  5. Execute o comando CREATE API INTEGRATION que você digitou acima.

Registre o API_AWS_IAM_USER_ARN e API_AWS_EXTERNAL_ID

  1. Execute o comando DESCRIBE INTEGRATION.

    DESCRIBE INTEGRATION <my_integration_name>;
    
    Copy

    Por exemplo:

    DESCRIBE INTEGRATION my_api_integration_01;
    
    Copy
  2. Procure a propriedade chamada API_AWS_IAM_USER_ARN e registre o property_value da propriedade na planilha de rastreamento.

  3. Procure a propriedade chamada API_AWS_EXTERNAL_ID e registre o property_value da propriedade na planilha de rastreamento.

    Observe que o property_value da API_AWS_EXTERNAL_ID muitas vezes termina com um sinal de igual (“=”). Esse sinal de igual faz parte do valor; certifique-se de cortá-lo e colá-lo junto com o resto do property_value.

Para as próximas etapas, você deve retornar à sua janela de administração da AWS. Não feche ainda sua janela de administração do Snowflake; você deve voltar a ela depois.

Próxima etapa

Etapa 4: vincular a integração de API da AWS ao serviço de proxy no Console de gerenciamento