Objetos de resposta de recursos personalizados

Campos de resposta Custom Resource Provider

As seguintes são propriedades que o provedor de recursos personalizados inclui ao enviar o arquivo JSON à URL pré-assinada. Para obter mais informações sobre o upload de objetos usando URLs pré-assinados, consulte o tópico relacionado no Guia do usuário do Amazon Simple Storage Service.

nota

O tamanho total do corpo da resposta não pode exceder 4096 bytes.

Status

O valor de status enviado pelo provedor de recursos personalizados em resposta a uma solicitação gerada pelo AWS CloudFormation.

Deve ser SUCCESS ou FAILED.

Obrigatório: Sim

Tipo: string

Motivo

Descreve o motivo de uma resposta de falha.

Obrigatório: obrigatório se Status for FAILED. Caso contrário, será opcional.

Tipo: string

PhysicalResourceId

Esse valor deve ser um identificador exclusivo do fornecedor de recursos personalizados e pode ter até 1 KB de tamanho. O valor deve ser uma string não vazia e deve ser idêntico para todas as respostas do mesmo recurso.

O valor retornado para um PhysicalResourceId pode alterar as operações de atualização de recursos personalizados. Se o valor retornado for o mesmo, a atualização é considerada normal. Se o valor retornado for diferente, o AWS CloudFormation reconhece a atualização como uma substituição e envia uma solicitação de exclusão ao recurso antigo. Para ter mais informações, consulte AWS::CloudFormation::CustomResource.

Obrigatório: Sim

Tipo: string

StackId

O nome do recurso da Amazon (ARN) que identifica a pilha que contém o recurso personalizado. Esse valor de resposta deve ser copiado literalmente com base na solicitação.

Obrigatório: Sim

Tipo: string

RequestId

Um ID exclusivo para a solicitação. Esse valor de resposta deve ser copiado literalmente com base na solicitação.

Obrigatório: Sim

Tipo: string

LogicalResourceId

O nome do modelo escolhido pelo desenvolvedor (ID lógico) do recurso personalizado no modelo AWS CloudFormation. Esse valor de resposta deve ser copiado literalmente com base na solicitação.

Obrigatório: Sim

Tipo: string

NoEcho

Opcional. Indica se é necessário mascarar a saída do recurso personalizado quando ela for recuperada usando a função Fn::GetAtt. Se definido como true, todos os valores retornados serão mascarados com asteriscos (*****), exceto aqueles armazenados na seção Metadata do modelo. O AWS CloudFormation não transforma, modifica nem edita nenhuma informação incluída na seção Metadata. O valor padrão é false.

Para obter mais informações sobre o uso de NoEcho para mascarar informações confidenciais, consulte a melhor prática Não incorporar credenciais em seus modelos.

Obrigatório: Não

Tipo: booliano

Dados

Opcional. Os pares de nome/valor definidos pelo provedor de recursos personalizados a serem enviados com a resposta. É possível acessar os valores fornecidos aqui pelo nome no modelo com Fn::GetAtt.

Importante

Se os pares de nome/valor contiverem informações confidenciais, você deverá utilizar o campo NoEcho para mascarar a saída do recurso personalizado. Caso contrário, os valores estarão visíveis por meio de APIs que exibem valores de propriedades (como DescribeStackEvents).

Obrigatório: não

Tipo: objeto JSON