AWS::CloudFormation::Interface - AWS CloudFormation

AWS::CloudFormation::Interface

AWS::CloudFormation::Interface é uma chave de metadados que define como os parâmetros são agrupadas e classificados no console do AWS CloudFormation. Quando você cria ou atualiza pilhas no console, o console lista os parâmetros de entrada em ordem alfabética pelos IDs lógicos. Usando essa chave, você pode definir seu próprio agrupamento e classificação de parâmetros de forma que os usuários possam especificar valores de parâmetros de forma eficiente. Por exemplo, você pode agrupar todos os parâmetros relacionados ao EC2 em um grupo e todos os parâmetros relacionados à VPC em outro grupo.

Além do agrupamento e da classificação dos parâmetros, você pode definir rótulos para os parâmetros. Um rótulo é um nome amigável ou uma descrição que o console exibe em vez de um ID lógico do parâmetro. Os rótulos são úteis para ajudar os usuários a compreenderem os valores a serem especificados para cada parâmetro. Por exemplo, você pode rotular um parâmetro KeyPair Select an EC2 key pair.

nota

Somente o console CloudFormation usa a chave de metadados AWS::CloudFormation::Interface.O AWS CLIe as chamadas de API não usam essa chave.

Sintaxe

Para declarar esta entidade no modelo do CloudFormation, use a seguinte sintaxe:

JSON

"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [ ParameterGroup, ... ], "ParameterLabels" : ParameterLabel } }

YAML

Metadata: AWS::CloudFormation::Interface: ParameterGroups: - ParameterGroup ParameterLabels: ParameterLabel

Properties

ParameterGroups

Uma lista de tipos de parameter group, em que você especifica nomes de grupo, os parâmetros em cada grupo e a ordem na qual os parâmetros são mostrados.

Required: No

Tipo: AWS::CloudFormation::Interface ParameterGroup

Atualização necessária: Sem interrupção

ParameterLabels

Um mapeamento de parâmetros e os nomes amigáveis deles que o console do CloudFormation mostra quando uma pilha é criada ou atualizada.

Required: No

Tipo: AWS::CloudFormation::Interface ParameterLabel

Atualização necessária: Sem interrupção

Exemplo

O exemplo a seguir define dois parameter groups: Network Configuration e Amazon EC2 Configuration. O grupo Network Configuration inclui os parâmetros VPCID, SubnetIde SecurityGroupID, que são definidos na seção Parameters do modelo (não mostrado). A ordem na qual o console mostra esses parâmetros é definida pela ordem na qual os parâmetros são listados, começando com o parâmetro VPCID. O exemplo agrupa e classifica os parâmetros Amazon EC2 Configuration de forma semelhante.

O exemplo também define um rótulo para o parâmetro VPCID. O console exibirá a mensagem Which VPC should this be deployed to? (A qual VPC isso deve ser implantado?) em vez de exibir o ID lógico do parâmetro (VPCID).

JSON

"Metadata" : { "AWS::CloudFormation::Interface" : { "ParameterGroups" : [ { "Label" : { "default" : "Network Configuration" }, "Parameters" : [ "VPCID", "SubnetId", "SecurityGroupID" ] }, { "Label" : { "default":"Amazon EC2 Configuration" }, "Parameters" : [ "InstanceType", "KeyName" ] } ], "ParameterLabels" : { "VPCID" : { "default" : "Which VPC should this be deployed to?" } } } }

YAML

Metadata: AWS::CloudFormation::Interface: ParameterGroups: - Label: default: "Network Configuration" Parameters: - VPCID - SubnetId - SecurityGroupID - Label: default: "Amazon EC2 Configuration" Parameters: - InstanceType - KeyName ParameterLabels: VPCID: default: "Which VPC should this be deployed to?"

Grupos de parâmetros no console

Usando a chave de metadados deste exemplo, a figura a seguir mostra como o console exibe os parameter groups quando uma pilha é criada ou atualizada: Parameter groups no console


               Console mostrando os parameter groups deste exemplo.