Objetos de respuesta de recursos personalizados - AWS CloudFormation
Campos de respuesta del proveedor de recursos personalizados

Objetos de respuesta de recursos personalizados

En este tema se describen las propiedades del objeto de respuesta de un recurso personalizado de CloudFormation.

Para obtener una introducción a los recursos personalizados y a su funcionamiento, consulte Crear una lógica de aprovisionamiento personalizada con recursos personalizados.

Campos de respuesta del proveedor de recursos personalizados

Estas son propiedades que el proveedor de recursos personalizados incluye al enviar el archivo JSON a la URL prefirmada. Para obtener más información acerca de la carga de objetos mediante direcciones URL prefirmadas, consulte el tema relacionado en la Guía del usuario de Amazon Simple Storage Service.

nota

El tamaño total del cuerpo de la respuesta no puede superar los 4096 bytes.

Status

El valor de estado que envía el proveedor de recursos personalizados en respuesta a una solicitud generada por AWS CloudFormation.

Debe ser SUCCESS o FAILED.

Obligatorio: sí

Tipo: cadena

Reason

Describe el motivo de una respuesta de error.

Obligatorio: obligatorio si Status es FAILED. De lo contrario, es opcional.

Tipo: cadena

PhysicalResourceId

Este valor debe ser un identificador exclusivo del proveedor de recursos personalizados y puede tener un tamaño máximo de 1 KB. El valor debe ser una cadena que no esté vacía y debe ser idéntica para todas las respuestas del mismo recurso.

El valor devuelto para un PhysicalResourceId puede cambiar las operaciones de actualización de recursos personalizadas. Si el valor devuelto es el mismo, se considera una actualización normal. Si el valor es diferente, AWS CloudFormation reconoce la actualización como un reemplazo y envía una solicitud de eliminación al antiguo recurso. Para obtener más información, consulte AWS::CloudFormation::CustomResource.

Obligatorio: sí

Tipo: cadena

StackId

El nombre de recurso de Amazon (ARN) que identifica la pila que contiene el recurso personalizado. Este valor de respuesta debe copiarse literalmente de la solicitud.

Obligatorio: sí

Tipo: cadena

RequestId

Un ID único para la solicitud. Este valor de respuesta debe copiarse literalmente de la solicitud.

Obligatorio: sí

Tipo: cadena

LogicalResourceId

El nombre elegido por el desarrollador de la plantilla (ID lógico) del recurso personalizado en la plantilla de AWS CloudFormation. Este valor de respuesta debe copiarse literalmente de la solicitud.

Obligatorio: sí

Tipo: cadena

NoEcho

Opcional. Indique si se enmascara la salida del recurso personalizado cuando se recupera con la función Fn::GetAtt. Si se establece en true, todos los valores devueltos se enmascaran con asteriscos (*****), excepto los que se almacenan en la sección Metadata de la plantilla. AWS CloudFormation no transforma, modifica ni redacta ninguna información que incluya en la sección Metadata. El valor predeterminado es false.

Para obtener más información sobre cómo usar NoEcho para enmascarar información confidencial, consulte la práctica recomendada No incluya credenciales en sus plantillas.

Obligatorio: no

Tipo: booleano

Data

Opcional. Los pares de nombre-valor definidos por el proveedor de recursos personalizados que se enviarán con la respuesta. Puede acceder a los valores proporcionados aquí por nombre en la plantilla con Fn::GetAtt.

importante

Si los pares nombre-valor contienen información confidencial, debe usar el campo NoEcho para enmascarar la salida del recurso personalizado. De lo contrario, los valores son visibles a través de las API que muestran valores de propiedades (como DescribeStackEvents).

Obligatorio: no

Tipo: objeto JSON