Referencia sintáctica de la sección Metadata para las plantillas de CloudFormation
Puede utilizar la sección Metadata
opcional para incluir objetos JSON o YAML arbitrarios que proporcionan detalles sobre la plantilla. Por ejemplo, puede incluir detalles de la implementación de la plantilla sobre recursos concretos, como se muestra en el siguiente fragmento de código:
importante
Durante la actualización de una pila, no puede actualizar la sección Metadata
por sí misma. Puede actualizarla solo cuando incluye cambios que añaden, modifican o eliminan recursos.
importante
CloudFormation no transforma, modifica ni redacta ninguna información que incluya en la sección Metadata
. Debido a esto, recomendamos encarecidamente que no utilice esta sección para almacenar información confidencial, como contraseñas o secretos.
JSON
"Metadata" : { "Instances" : {"Description" : "Information about the instances"}, "Databases" : {"Description" : "Information about the databases"} }
YAML
Metadata: Instances: Description: "Information about the instances" Databases: Description: "Information about the databases"
Claves de metadatos
Algunas características de CloudFormation recuperan ajustes o información de configuración que se define en la sección Metadata
. Puede definir esta información en las siguientes claves de metadatos específicos de CloudFormation:
AWS::CloudFormation::Init
-
Define tareas de configuración para el script auxiliar cfn-init. Este script es útil para la configuración y la instalación de aplicaciones en instancias de EC2. Para obtener más información, consulte AWS::CloudFormation::Init.
AWS::CloudFormation::Interface
-
Define el agrupamiento y ordenación de parámetros de entrada cuando se muestran en la consola de CloudFormation. De forma predeterminada, la consola de CloudFormation ordena alfabéticamente parámetros por su ID lógico. Para obtener más información, consulte AWS::CloudFormation::Interface.
AWS::CloudFormation::Designer
-
Describe cómo se presentan los recursos en AWS CloudFormation Designer (Designer). Designer agrega automáticamente esta información cuando lo utiliza para crear y actualizar plantillas. Para obtener más información, consulte Uso del Diseñador de AWS CloudFormation anterior para crear plantillas.