Sintaxe de Metadata de modelo do CloudFormation
Metadata armazena informações adicionais usando objetos JSON ou YAML. Os tipos de metadados em nível de modelo que você pode usar em seu modelo incluem:
- Metadados personalizados
-
Armazena pares de chave-valor definidos pelo usuário. Por exemplo, você pode fornecer informações adicionais que não afetam a criação de recursos, mas oferecem contexto adicional sobre as especificidades da infraestrutura, da equipe ou da implantação.
AWS::CloudFormation::Interface-
Define o agrupamento e a classificação de parâmetros de entrada quando eles são exibidos no console do CloudFormation. Por padrão, o console do CloudFormation classifica alfabeticamente os parâmetros por ID lógico.
AWS::CloudFormation::Designer-
O AWS CloudFormation Designer (Designer) atingiu o fim da vida útil em 5 de fevereiro de 2025.
Importante
Durante a atualização de uma pilha, você não pode atualizar a seção Metadata por si só. Você pode atualizá-la apenas ao incluir alterações que adicionam, modificam ou excluem recursos.
O CloudFormation não transforma, modifica nem edita nenhuma informação incluída na seção Metadata. Por isso, é altamente recomendável não usar essa seção para armazenar informações confidenciais, como senhas ou segredos.
Sintaxe
Para declarar metadados personalizados no modelo do CloudFormation, use a seguinte sintaxe:
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"
Para obter a sintaxe do AWS::CloudFormation::Interface, consulte Organizar parâmetros do CloudFormation com metadados AWS::CloudFormation::Interface.
