AWS CloudFormation — Referenciando parâmetros com !Ref no YAML

Olá pessoal,

Seguindo nossa série de posts sobre Cloud Formation, depois de definir os parâmetros de um template do AWS CloudFormation, precisamos utilizar seus valores na configuração dos recursos. Para isso, podemos usar !Ref, a forma abreviada da função intrínseca Ref no YAML.

Ao referenciar um parâmetro, essa função retorna o valor informado na criação ou atualização da stack. Assim, uma configuração como o tipo de instância EC2 pode ser preenchida sem deixar seu valor fixo dentro do recurso.

Como utilizar !Ref no YAML

No exemplo abaixo, o parâmetro TipoInstancia define as opções disponíveis, enquanto !Ref TipoInstancia aplica a escolha à propriedade InstanceType:

Parameters:
TipoInstancia:
Type: String
Description: Selecione o tipo da instancia EC2
Default: t3.micro
AllowedValues:
- t3.micro
- t3.small
- t3.medium
AmiID:
Type: AWS::EC2::Image::Id
Description: Informe uma AMI compativel com a instancia
Resources:
MinhaInstancia:
Type: AWS::EC2::Instance
Properties:
ImageId: !Ref AmiID
InstanceType: !Ref TipoInstancia

Se você selecionar t3.small, o CloudFormation utilizará esse valor em InstanceType. Da mesma forma, !Ref AmiID recuperará o identificador da imagem informada.

O código é um trecho ilustrativo: adapte as configurações de rede e segurança ao seu ambiente e selecione uma AMI compatível com o tipo de instância.

Forma abreviada e forma completa

Estas duas formas são equivalentes:

InstanceType: !Ref TipoInstancia
InstanceType:
Ref: TipoInstancia

Em ambas, o nome após Ref identifica o parâmetro declarado no template. Já escrever apenas InstanceType: TipoInstancia fornece o texto literal, sem recuperar o valor do parâmetro.

Atenção ao referenciar recursos

O !Ref também pode apontar para recursos. Nesse caso, o retorno depende do tipo: para uma instância AWS::EC2::Instance, por exemplo, retorna o ID da instância, e não seu nome ou endereço IP. Confira sempre a seção de retorno de Ref na documentação do recurso.

Para começar, identifique um valor fixo que varia entre suas implantações, transforme-o em parâmetro e utilize !Ref na propriedade correspondente. Antes de atualizar uma stack existente, avalie o impacto da alteração sobre o recurso.

Mais detalhes estão na documentação oficial da função Ref.

Bom, espero ter ajudado e até a próxima!

Deixe um comentário

Este site utiliza o Akismet para reduzir spam. Saiba como seus dados em comentários são processados.