Métodos auxiliares para propriedades do CloudFront SaaS Manager - Amazon CloudFront

Métodos auxiliares para propriedades do CloudFront SaaS Manager

Use as funções auxiliares do CloudFront SaaS Manager a seguir para recuperar valores referentes às suas distribuições multilocatário na função que você criar. Para usar exemplos nessa página, você deve primeiro criar uma função do CloudFront usando o runtime 2.0 do JavaScript. Para obter mais informações, Recursos de runtime 2.0 do JavaScript para CloudFront Functions.

Grupos de conexões

O grupo de conexões associado aos locatários da distribuição tem um nome de domínio.

Para obter esse valor, use o campo endpoint do subobjeto context do objeto do evento.

Solicitação

const value = event.context.endpoint;

Resposta

A resposta é uma string que contém o nome de domínio do grupo de conexões, como d111111abcdef8.cloudfront.net. O campo endpoint só aparece quando a função é invocada para uma distribuição multilocatário com um grupo de conexões associado. Para obter mais informações, consulte Objeto de contexto.

Locatários da distribuição

O CloudFront Functions tem um módulo que oferece acesso a valores específicos de locatários da distribuição.

Para usar esse módulo, inclua a seguinte instrução na primeira linha do código da função:

import cf from 'cloudfront';

Você pode usar os exemplos a seguir somente na função handler, tanto diretamente quanto por meio de qualquer função de chamada aninhada.

distributionTenant.id field

Use esse campo para obter o valor do ID do locatário da distribuição.

Solicitação

const value = cf.distributionTenant.id;

Resposta

A resposta é uma string que contém o ID do locatário da distribuição, como dt_1a2b3c4d5e6f7.

Como tratar erros

Se a função for invocada para uma distribuição padrão, ao especificar o campo distributionTenant.id, será exibido o erro de tipo distributionTenant module is not available. Para lidar com esse caso de uso, é possível adicionar um bloco try e catch ao seu código.

Método distributionTenant.parameters.get()

Use esse método para retornar o valor dos nomes de parâmetro de locatários da distribuição que você especificou.

distributionTenant.parameters.get("key");

key: o nome do parâmetro de locatário da distribuição para o qual você deseja buscar o valor.

Solicitação

const value = distributionTenant.parameters.get("key");

Resposta

A resposta é uma string que contém o valor do parâmetro do locatário da distribuição. Por exemplo, se o nome da chave for TenantPath, o valor desse parâmetro poderá ser tenant1.

Como tratar erros

Você poderá receber os seguintes erros:

  • Se sua função for invocada para uma distribuição padrão, o método distributionTenant.parameters.get() exibirá o erro de tipo distributionTenant module is not available.

  • O erro DistributionTenantParameterKeyNotFound é exibido quando o parâmetro do locatário da distribuição que você especificou não existe.

Para gerenciar esses casos de uso, é possível adicionar um bloco try e catch ao código.