Ref - AWS CloudFormation

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Ref

A função intrínseca Ref retorna o valor do recurso ou parâmetro especificado.

  • Quando você especifica um nome lógico do parâmetro, ele retorna o valor do parâmetro.

  • Quando você especifica o nome lógico de um recurso, ele retorna um valor que você pode geralmente usa para fazer referência a esse recurso, como uma ID física.

Quando você estiver declarando um recurso em um modelo e precisar especificar outro recurso de modelo pelo nome, use o Ref para fazer referência àquele outro recurso. Em geral, o Ref retorna o nome do recurso. Por exemplo, uma referência a um AWS::AutoScaling::AutoScalingGroup retorna o nome do recurso do grupo de Auto Scaling.

Para alguns recursos, um identificador é retornado com outro significado importante no contexto do recurso. Um recurso AWS::EC2::EIP, por exemplo, retorna o endereço IP, e um AWS::EC2::Instance retorna o ID da instância.

dica

Você também pode usar Ref para adicionar valores a mensagens de saída.

Para obter mais informações sobre valores de retorno Ref para um recurso ou uma propriedade específica, consulte a documentação desse recurso ou dessa propriedade na Referência de propriedades e recursos.

Declaração

JSON

{ "Ref" : "logicalName" }

YAML

Sintaxe para o nome da função completo:

Ref: logicalName

Sintaxe para a forma resumida:

!Ref logicalName

Parâmetros

logicalName

O nome lógico do recurso ou parâmetro que você deseja cancelar.

Valor de retorno

O ID físico do recurso ou o valor do parâmetro.

Exemplo

A seguinte declaração de recurso para um endereço IP elástico precisa do ID de instância de uma instância EC2 e usa a função Ref para especificar o ID da instância do recurso MyEC2Instance:

JSON

"MyEIP" : { "Type" : "AWS::EC2::EIP", "Properties" : { "InstanceId" : { "Ref" : "MyEC2Instance" } } }

YAML

MyEIP: Type: "AWS::EC2::EIP" Properties: InstanceId: !Ref MyEC2Instance

Funções compatíveis

Não use quaisquer funções na função Ref. Especifique uma string que seja um ID lógico do recurso.