Edición de plantillas visualmente con Template Studio

Template Studio es un editor de plantillas en la consola de CloudFormation. Muestra la plantilla como texto junto a un diagrama de los recursos que declara la plantilla. A medida que edita la plantilla, el diagrama se vuelve a dibujar para que coincida. Puede validar la plantilla, convertirla entre YAML y JSON y guardarla en Amazon S3 sin salir de la consola.

El texto de la plantilla es autoritativo. El diagrama es una representación visual de ese texto, no una superficie editable independiente. Todos los cambios se realizan en la plantilla.

Consideraciones

Tenga en cuenta lo siguiente cuando trabaje en Template Studio:

• La creación se realiza en la plantilla, no en el diagrama. El diagrama muestra los recursos que declara la plantilla y cómo se hacen referencia entre sí; no es posible agregar ni configurar un recurso editando el diagrama.

• Las modificaciones no se guardan automáticamente. Template Studio solicita confirmación antes de que salga sin haber guardado los cambios. Si sale de la página o la actualiza, se descartarán los cambios no guardados. Guarde en Amazon S3 o copie o descargue la plantilla antes de salir.

• Al convertir una plantilla de YAML a JSON, se descartan sus comentarios, ya que JSON no tiene sintaxis para ellos. Si se vuelve a convertir a YAML, no se restaura.

• La validación de CloudFormation en Template Studio no está disponible actualmente para borradores de más de 51 200 bytes (50 KiB). La acción de validación actual envía el borrador a través del parámetro TemplateBody, que tiene este límite. Este no es el límite general de tamaño de la plantilla. Aún puede guardar la plantilla y usarla en una operación de pila, sujeto a las cuotas de CloudFormation. Para más información, consulte Validar una plantilla.

• Al guardar, la plantilla se escribe en un bucket de su cuenta, por lo que las plantillas que guarde se facturan con las tarifas estándar de Amazon S3. Para obtener más información, consulte Precios de Amazon S3.

• Puede descargar el diagrama de recursos solo cuando el lienzo se muestre en la vista Lienzo o en la vista Ambos.

Permisos necesarios para Template Studio

Los permisos que necesita dependen del origen de la plantilla y de las acciones que realice:

cloudformation:GetTemplate

Obligatorio para abrir la plantilla de una pila existente. Conceda acceso a la pila cuya plantilla quiera editar.

s3:GetObject

Obligatorio para leer una plantilla de Amazon S3 con sus credenciales. Conceda acceso al objeto de plantilla de origen. Una URL prefirmada utiliza la autorización incluida en la URL.

cloudformation:ValidateTemplate

Obligatorio para elegir Validar.

s3:PutObject

Obligatorio para guardar una plantilla. Limite este permiso a los objetos del bucket de destino, por ejemplo arn:aws:s3:::destination-bucket/*, y no a todos los recursos.

s3:CreateBucket

Solo se requiere cuando la consola crea un bucket de destino que falta. Puede ser el bucket administrado por la consola o el nombre del bucket que especifique. La reutilización de un bucket existente no requiere este permiso.

s3:ListBucket

Obligatorio al guardar en un bucket existente que especifique. Template Studio usa HeadBucket para verificar el acceso, el propietario esperado del bucket y la Región de AWS del bucket antes de subirlo.

En el caso del bucket administrado por la consola, este permiso es opcional. Sin él, el cuadro de diálogo para guardar sigue mostrando el nombre del bucket. Para guardar es necesario s3:PutObject y, si es necesario crear el bucket, s3:CreateBucket.

Abrir Template Studio

El lugar desde el que se abre Template Studio determina con qué se abre y qué sucede después de guardarlo.

Para iniciar una plantilla nueva

1. Abra la consola de CloudFormation.

2. En la barra de navegación de la parte superior de la pantalla, elija la Región de AWS en la que tiene previsto realizar la implementación.

3. En el panel de navegación, elija Template Studio.

Para crear una plantilla mientras se crea una pila

1. En la página Crear pila, seleccione Crear con Template Studio.

2. Cree la plantilla y, a continuación, seleccione Guardar y continuar.

3. El asistente de pilas continúa con la plantilla que guardó, por lo que no tiene que subirla por separado.

Para editar la plantilla de una pila existente

1. En la página Pilas, seleccione el nombre de la pila.

2. Actualice la pila directamente o cree un conjunto de cambios.

3. En la página Preparar plantilla, seleccione Abrir en Template Studio. Se abre la plantilla actual de la pila.

4. Seleccione Guardar y continuar para volver a la actualización o al conjunto de cambios con la plantilla editada.

En cualquier parte de la consola, donde quiera que se muestre una plantilla, puede elegir Abrir en Template Studio para trabajar en ella.

Trabajar con la plantilla y el diagrama

Template Studio se abre y muestra la plantilla y el diagrama uno al lado del otro. Use el control de visualización para elegir lo que aparece en pantalla:

Template

Solo la plantilla, en toda su extensión. Utilícela para leer o escribir una plantilla sin el diagrama.

Lienzo

Solo el diagrama, en toda su extensión. Úselo para una plantilla grande en la que el diagrama requiera toda su extensión.

Ambos

La plantilla y el diagrama juntos. Arrastre el separador entre ellos para dejar más espacio a cada lado.

El diagrama agrupa los recursos relacionados y establece una conexión cuando un recurso hace referencia a otro mediante Ref, Fn::GetAtt, Fn::Sub o DependsOn. Un recurso al que nada hace referencia aparece por sí solo, lo que facilita la detección de un recurso que se ha desconectado accidentalmente.

nota

Por ejemplo, tres funciones pueden asumir el mismo rol de IAM. El diagrama muestra el rol dentro de cada función, pero la plantilla declara solo un rol. Consulte la plantilla para ver cuántos recursos existen.

Convertir entre YAML y JSON

El formato en el que guarde determinará el nombre de archivo y el tipo de contenido del objeto que Template Studio escribe en Amazon S3.

Para convertir la plantilla que está editando

1. Elija el control de formato, que indica el formato en el que se encuentra actualmente.

2. Elija el otro formato.

3. La conversión de YAML a JSON le pide que confirme, ya que los comentarios no se pueden transferir. Elija Continuar para continuar.

importante

JSON no tiene sintaxis para los comentarios. Al convertir una plantilla de YAML que contiene comentarios a JSON, esos comentarios se eliminan y, al volver a convertirlos a YAML, no se restauran. Copie todo lo que quiera conservar antes de realizar la conversión.

El control de formato no está disponible mientras no se pueda leer la plantilla porque no hay nada lo suficientemente completo como para convertirla. Primero corrija la plantilla.

Problemas de sintaxis al escribir

El editor comprueba la sintaxis de la plantilla mientras la escribe y subraya lo que no puede leer: un corchete de cierre que falta, una sangría mal colocada o una clave duplicada. Coloque el cursor sobre un subrayado para ver el problema. Si una línea tiene varios problemas, están numerados para que pueda distinguirlos.

Se trata de una comprobación de la sintaxis de la plantilla, no de su contenido. El editor no sabe qué tipos de recursos existen ni qué propiedades toman, por lo que una plantilla YAML perfectamente formada puede seguir siendo errónea en aspectos que solo CloudFormation puede indicarle. Para ello, elija Validar.

Validación de una plantilla

La validación comprueba la sintaxis de la plantilla con el editor y comprueba la plantilla con CloudFormation antes de utilizarla en una operación de pila. Ambas comprobaciones utilizan el borrador actual, incluidos los cambios que no haya guardado. Una comprobación correcta de CloudFormation no anula los errores de sintaxis que notifica el editor.

nota

Template Studio envía el borrador a la API ValidateTemplate mediante el parámetro TemplateBody. Este parámetro tiene un límite de 51 200 bytes (50 KiB).

En el caso de un borrador que supere este límite, Template Studio no envía la solicitud de CloudFormation. La comprobación de CloudFormation no está disponible, pero esto no significa que la plantilla no sea válida. El editor aún puede indicar errores de sintaxis.

La misma API admite plantillas de hasta 1 MB a través de TemplateURL. Template Studio no carga los borradores editados para su validación basada en URL. Puede guardar la plantilla en Amazon S3 y validarla mediante una operación de pila, sujeta a las cuotas de CloudFormation.

Para convertir la plantilla que está editando

1. Elija Validar.

2. Una plantilla que pase ambas comprobaciones se declara válida.

3. Si alguna de las comprobaciones encuentra errores, revíselos en el mensaje de validación. Los errores del editor incluyen los números de línea y columna. Corrija los errores en el editor y valide de nuevo.

Guardar una plantilla en Amazon S3

CloudFormation lee las plantillas para las operaciones de pila de Amazon S3, por lo que guardar es lo que hace que la plantilla esté disponible para el resto de la consola.

Utilice referencias dinámicas a los secretos almacenados en Secrets Manager o cadenas seguras en Systems Manager Parameter Store en lugar de incluir los secretos en texto plano en las plantillas guardadas. Para obtener más información, consulte Obtención de valores almacenados en otros servicios con referencias dinámicas.

Para guardar la plantilla que está editando

1. Elija Guardar y continuar.

2. Compruebe el destino. De forma predeterminada, la plantilla va al bucket de Amazon S3 que CloudFormation administra para las plantillas cargadas en la Región de AWS actual. Si ese bucket aún no existe, CloudFormation lo crea al guardarlo y lo reutiliza para las plantillas que guarde más adelante.

   1. Para elegir su propio destino, elija Usar un bucket diferente e introduzca un nombre de bucket. El bucket se crea si aún no existe.

3. Seleccione Confirmar y continuar.

nota

Las plantillas almacenadas en Amazon S3 se facturan según las tarifas estándar de Amazon S3, independientemente del bucket en el que estén. Para obtener más información, consulte Precios de Amazon S3.

Para guardar, no es necesario que el resultado de la validación sea correcto. Cuando la validación encuentra errores, Template Studio le pide que confirme si desea guardar de todos modos. Guardar no corrige esos errores; revíselos y corríjalos antes de utilizar la plantilla en una operación de pila.

Copiar o descargar una plantilla o un diagrama

Elija Acciones de plantilla para sacar la plantilla o el diagrama de la consola:

Copiar plantilla

Copia la plantilla tal como aparece en el editor en el portapapeles.

Descargar plantilla

Guarda la plantilla como un archivo, en el formato en el que se está editando actualmente.

Descargar diagrama de recursos

Guarda el diagrama como una imagen PNG. Como la imagen es una captura del diagrama, solo está disponible cuando el diagrama está en pantalla.