Referência de sintaxe de seção Metadata para modelos do CloudFormation - AWS CloudFormation
JSONYAMLChaves de metadados

Referência de sintaxe de seção Metadata para modelos do CloudFormation

Você pode usar a seção Metadata opcional para incluir objetos JSON ou YAML arbitrários que fornecem detalhes sobre o modelo. Por exemplo, você pode incluir detalhes da implementação do modelo sobre recursos específicos, conforme mostrado no trecho a seguir:

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.

Importante

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.

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"

Chaves de metadados

Alguns recursos do CloudFormation recuperam informações de definições ou da configuração que você define na seção Metadata. Você define essas informações nas seguintes chaves de metadados específicas do CloudFormation:

AWS::CloudFormation::Init

Define tarefas de configuração para o script auxiliar cfn-init. Esse script é útil para configurar e instalar aplicativos em instâncias EC2. Para ter mais informações, consulte AWS::CloudFormation::Init.

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. Para ter mais informações, consulte AWS::CloudFormation::Interface.

AWS::CloudFormation::Designer

Descreve como seus recursos são apresentados no AWS CloudFormation Designer (Designer). O Designer adiciona automaticamente essas informações quando você o utiliza para criar e atualizar modelos. Para ter mais informações, consulte Usar o AWS CloudFormation Designer antigo para criar modelos.