CREATE EXTERNAL SCHEMA

Cláusula que indica que, se o esquema especificado existe, o comando não deve fazer alterações e retorna uma mensagem informando que o esquema existe, em vez de encerrar com um erro. Esta cláusula é útil para realizar desenvolvimento de scripts para que o script não falhe se o comando CREATE EXTERNAL SCHEMA tentar criar um esquema que já existe.

Nome do novo esquema externo. Para obter mais informações sobre nomes válidos, consulte Nomes e identificadores.

Uma palavra-chave que indica onde o banco de dados externo está localizado.

DATA CATALOG indica que o banco de dados externo está definido no catálogo de dados do Athena ou do AWS Glue Data Catalog.

Se o banco de dados externo estiver definido em um catálogo de dados em uma região da AWS diferente, o parâmetro REGION será obrigatório. DATA CATALOG é o valor padrão.

HIVE METASTORE indica que o banco de dados externo está definido em um metastore do Apache Hive. Se HIVE METASTORE estiver especificado, URI será obrigatório.

POSTGRES indica que o banco de dados externo está definido em RDS PostgreSQL ou Aurora PostgreSQL.

O MYSQL indica que o banco de dados externo está definido no RDS MySQL ou no Aurora MySQL.

O KINESIS indica que a fonte de dados é uma transmissão do Kinesis Data Streams.

O MSK indica que a fonte de dados é um cluster provisionado ou sem servidor do Amazon MSK.

Uma palavra-chave que indica que o banco de dados está localizado no Amazon Redshift.

O nome do banco de dados do Amazon Redshift.

O redshift_schema_name indica o esquema no Amazon Redshift. O valor redshift_schema_name é public.

Uma palavra-chave que indica o nome do banco de dados externo em um mecanismo de banco de dados PostgreSQL ou MySQL compatível.

O schema_name indica o esquema em um mecanismo de banco de dados PostgreSQL compatível. O schema_name padrão é public.

Você não pode especificar um SCHEMA ao configurar uma consulta federada para um mecanismo de banco de dados MySQL compatível.

Se o banco de dados externo for definido em um catálogo de dados do Athena ou do AWS Glue Data Catalog, a região da AWS na qual o banco de dados estará localizado. Esse parâmetro é necessário se o banco de dados for definido em um catálogo de dados .

O URI de nome de host e port_number de um mecanismo de banco de dados PostgreSQL ou MySQL compatível. O hostname é o nó de cabeçalho do conjunto de réplicas. O endpoint deve ser acessível (roteável) pelo cluster do Amazon Redshift. O port_number padrão do PostgreSQL é 5432. O port_number padrão do MySQL é 3306.

Especificar um URI de metastore do Hive

Se o banco de dados estiver em um metastore do Hive, especifique o URI e, como opção, o número da porta do metastore. O número da porta padrão é 9083.

Um URI não contém uma especificação de protocolo (“http://”). Um exemplo de URI válido: uri '172.10.10.10'.

Especificar um URI de agente para ingestão de streaming

A inclusão do URI do agente de bootstrap permite que você se conecte com um cluster do Amazon MSK e receba os dados transmitidos. Consulte mais informações e um exemplo em Conceitos básicos da ingestão de streaming do Amazon Managed Streaming para Apache Kafka.

Use a palavra-chave padrão para que o Amazon Redshift use a função do IAM definida como padrão e associada ao cluster quando o comando CREATE EXTERNAL SCHEMA for executado.

Use 'SESSION' se você se conectar ao cluster do Amazon Redshift usando uma identidade federada e acesse as tabelas do esquema externo criado usando esse comando. Para obter mais informações, consulte “Using a federated identity to manage Amazon Redshift access to local resources and Amazon Redshift Spectrum external tables” (Usar uma identidade federada para gerenciar o acesso do Amazon Redshift aos recursos locais e a tabelas externas do Amazon Redshift Spectrum), que explica como configurar uma identidade federada. Observe que essa configuração, que usa 'SESSION' no lugar do ARN, só poderá ser usada se o esquema for criado usando DATA CATALOG.

Use o nome do recurso da Amazon (ARN) de uma função do IAM que seu cluster usa para autenticação e autorização. No mínimo, a função do IAM deve ter permissão para executar uma operação LIST no bucket do Amazon S3 a ser acessado e uma operação GET nos objetos do Amazon S3 que constam no bucket.

O exemplo a seguir mostra a sintaxe da string do parâmetro IAM_ROLE para um único ARN.

IAM_ROLE 'arn:aws:iam::<aws-account-id>:role/<role-name>'

Você pode encadear funções para que seu cluster possa assumir outra função do IAM, possivelmente pertencente a outra conta. Você pode encadear até 10 funções. Para ver um exemplo de perfis de encadeamento, consulte Encadeamento de funções do IAM no Amazon Redshift Spectrum.

Anexe a essa função do IAM uma política de permissões do IAM semelhante à política descrita a seguir.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AccessSecret",
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetResourcePolicy",
                "secretsmanager:GetSecretValue",
                "secretsmanager:DescribeSecret",
                "secretsmanager:ListSecretVersionIds"
            ],
            "Resource": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-rds-secret-VNenFy"
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetRandomPassword",
                "secretsmanager:ListSecrets"
            ],
            "Resource": "*"
        }
    ]
}

Para obter as etapas para criar uma função do IAM a ser usada com consulta federada, consulte Criar um segredo e uma função do IAM para usar consultas federadas.

O seguinte mostra a sintaxe do encadeamento de três funções.

IAM_ROLE 'arn:aws:iam::<aws-account-id>:role/<role-1-name>,arn:aws:iam::<aws-account-id>:role/<role-2-name>,arn:aws:iam::<aws-account-id>:role/<role-3-name>'

O nome do recurso da Amazon (ARN) de um segredo de mecanismo de banco de dados PostgreSQL ou MySQL compatível criado usando o AWS Secrets Manager. Para obter informações sobre como criar e recuperar um ARN para um segredo, consulte Criar um segredo básico e Recuperar o segredo do valor do segredo no AWS Secrets ManagerManual do usuário.

Use 'SESSION' para se conectar ao cluster do Amazon Redshift usando uma identidade federada para autenticação e autorização para o catálogo de dados. Para obter mais informações sobre como concluir as etapas da identidade federada, consulte “Using a federated identity to manage Amazon Redshift access to local resources and Amazon Redshift Spectrum external tables” (Usar uma identidade federada para gerenciar o acesso do Amazon Redshift aos recursos locais e a tabelas externas do Amazon Redshift Spectrum). Observe que o perfil 'SESSION' só poderá ser usado se o esquema for criado no CATÁLOGO DE DADOS.

Use o nome do recurso da Amazon (ARN) de um perfil do IAM que o cluster usa para autenticação e autorização do catálogo de dados.

Se CATALOG_ROLE não for especificado, o Amazon Redshift usará a IAM_ROLE especificada. A função do catálogo deve ter permissão para acessar o catálogo de dados no AWS Glue ou Athena. Para obter mais informações, consulte Políticas do IAM do Amazon Redshift Spectrum.

O exemplo a seguir mostra a sintaxe da string do parâmetro CATALOG_ROLE para um único ARN.

CATALOG_ROLE 'arn:aws:iam::<aws-account-id>:role/<catalog-role>'

Você pode encadear funções para que seu cluster possa assumir outra função do IAM, possivelmente pertencente a outra conta. Você pode encadear até 10 funções. Para obter mais informações, consulte Encadeamento de funções do IAM no Amazon Redshift Spectrum.

O seguinte mostra a sintaxe do encadeamento de três funções.

CATALOG_ROLE 'arn:aws:iam::<aws-account-id>:role/<catalog-role-1-name>,arn:aws:iam::<aws-account-id>:role/<catalog-role-2-name>,arn:aws:iam::<aws-account-id>:role/<catalog-role-3-name>'

Cláusula que cria um banco de dados externo com o nome especificado pelo argumento DATABASE, se o banco de dados externo especificado não existir. Se o banco de dados externo especificado existir, o comando não realizará alterações. Nesse caso, o comando retorna uma mensagem informando que o banco de dados externo existe, em vez de finalizar com um erro.

O ID da conta em que o banco de dados do catálogo de dados está armazenado.

CATALOG_ID só pode ser especificado se você planeja se conectar ao cluster do Amazon Redshift ou ao Amazon Redshift Serverless usando uma identidade federada para autenticação e autorização do catálogo de dados por meio da definição de uma das seguintes opções:

Para obter mais informações sobre como concluir as etapas da identidade federada, consulte “Using a federated identity to manage Amazon Redshift access to local resources and Amazon Redshift Spectrum external tables” (Usar uma identidade federada para gerenciar o acesso do Amazon Redshift aos recursos locais e a tabelas externas do Amazon Redshift Spectrum).

O tipo de autenticação definido para ingestão de streaming. A ingestão de streaming com tipos de autenticação funciona com o Managed Streaming for Apache Kafka. Os tipos de AUTHENTICATION são os seguintes:

O ARN do certificado do AWS Certificate Manager usado pelo Amazon Redshift para autenticação mTLS com o Amazon MSK. O ARN está disponível no console do ACM quando você escolhe o certificado emitido.

Para ingestão de streaming, o CLUSTER_ARN é o identificador do cluster do Amazon Managed Streaming para Apache Kafka do qual você está transmitindo. Ao usar CLUSTER_ARN, é necessária uma política de perfil do IAM que inclua a permissão kafka:GetBootstrapBrokers. Essa opção é fornecida para compatibilidade com versões anteriores. No momento, recomendamos usar a opção de URI do agente de bootstrap para conexão com os clusters do Amazon Managed Streaming para Apache Kafka. Para obter mais informações, consulte Ingestão de streaming.