Objetos de solicitudes de recursos personalizados

Propiedades de las solicitudes de desarrolladores de plantillas

El desarrollador de plantillas usa el recurso de AWS CloudFormation, AWS::CloudFormation::CustomResource, para especificar un recurso personalizado en una plantilla.

En AWS::CloudFormation::CustomResource, todas las propiedades las define custom resource provider. Solo hay una propiedad necesaria: ServiceToken.

ServiceToken

El token de servicio (un tema de Amazon SNS o un nombre de recurso de Amazon de función de AWS Lambda) que se obtiene del proveedor de recursos personalizados para obtener acceso al servicio. El token de servicio debe estar la misma región en la que está creando la pila.

Obligatorio: sí

Tipo: cadena

El resto de los campos de las propiedades de recursos son opcionales y se envían, literalmente, al custom resource provider en el campo ResourceProperties de las solicitudes. El proveedor define los nombres y el contenido válido de estos campos.

Campos de solicitud del proveedor de recursos personalizados

Estos campos se envían en las solicitudes JSON desde AWS CloudFormation al proveedor de recursos personalizados en el tema de SNS que el proveedor ha configurado para este fin.

RequestType

La operación de pila de AWS CloudFormation establece el tipo de solicitud (creación de la pila, actualización de la pila o eliminación de la pila) iniciado por el desarrollador de plantillas para la pila que contiene el recurso personalizado.

Debe ser uno de los siguientes: Create, Update o Delete. Para obtener más información, consulte Tipos de solicitud de recurso personalizados.

Obligatorio: sí

Tipo: cadena

ResponseURL

La URL de respuesta identifica un bucket de S3 prefirmado que recibe respuestas del proveedor de recursos personalizados para AWS CloudFormation.

Obligatorio: sí

Tipo: cadena

StackId

El nombre de recurso de Amazon (ARN) que identifica la pila que contiene el recurso personalizado.

La combinación de StackId con RequestId forma un valor que puede usar para identificar de forma única una solicitud en un recurso personalizado en particular.

Obligatorio: sí

Tipo: cadena

RequestId

Un ID único para la solicitud.

La combinación de StackId con RequestId forma un valor que puede usar para identificar de forma única una solicitud en un recurso personalizado en particular.

Obligatorio: sí

Tipo: cadena

Tipo de recurso

El tipo de recurso elegido por el desarrollador de la plantilla del recurso personalizado en la plantilla AWS CloudFormation. Los nombres de tipos de recursos personalizados pueden tener una longitud máxima de 60 caracteres y pueden incluir caracteres alfanuméricos y los siguientes caracteres: _@-.

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. Se proporciona para facilitar la comunicación entre el proveedor de recursos personalizados y el desarrollador de plantillas.

Obligatorio: sí

Tipo: cadena

PhysicalResourceId

Un ID físico necesario con definición custom resource provider que es exclusivo de dicho proveedor.

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: se envía siempre con solicitudes Update y Delete; nunca se envía con Create.

Tipo: cadena

ResourceProperties

Este campo contiene el contenido del objeto Properties enviado por el desarrollador de la plantilla. El proveedor de recursos personalizado define su contenido.

Obligatorio: no

Tipo: objeto JSON

OldResourceProperties

Usado solo para solicitudes Update. Contiene las propiedades del recurso que se declararon antes de la solicitud de actualización.

Obligatorio: sí

Tipo: objeto JSON