Este é o novo *Guia de referência de modelos do CloudFormation*. Atualize seus favoritos e links. Para obter ajuda para começar a usar o CloudFormation, consulte o [Guia do usuário do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# `Ref`
<a name="intrinsic-function-reference-ref"></a>

A função intrínseca `Ref` retorna o valor do recurso, parâmetro ou outra função intrínseca especificada. Essa função é comumente usada para criar referências entre recursos em um modelo do CloudFormation. 

## Declaração
<a name="ref-declaration"></a>

### JSON
<a name="intrinsic-function-reference-ref-syntax.json"></a>

```
{ "Ref" : "logicalName" }
```

```
{ "Ref" : "IntrinsicFunction" }
```

### YAML
<a name="intrinsic-function-reference-ref-syntax.yaml"></a>

Sintaxe para o nome da função completo:

```
Ref: logicalName
```

```
Ref:
   IntrinsicFunction
```

Sintaxe para a forma resumida:

```
!Ref logicalName
```

```
!Ref
   IntrinsicFunction
```

## Parâmetros
<a name="ref-parameters"></a>

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

IntrinsicFunction  
A função intrínseca que é resolvida como uma string válida. Ela deve conter referências a parâmetros ou identificadores e não deve conter identificadores lógicos de recursos.

## Valor de retorno
<a name="ref-return-value"></a>

O valor de retorno de `Ref` depende do tipo de entidade que está sendo referenciada:
+ Quando você especifica um nome lógico do parâmetro, ele retorna o valor do parâmetro. Para obter mais informações, consulte [Sintaxe do modelo Parameters do CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html).
+ Quando você especifica o nome lógico de um recurso, ele retorna um valor que você usa para identificar esse recurso. Normalmente, esse é o nome do recurso. No entanto, para alguns recursos, um identificador é retornado com outro significado importante no contexto do recurso. Por exemplo, o recurso `AWS::EC2::EIP` retorna o endereço IP, enquanto `AWS::EC2::Instance` retorna o ID da instância. Para obter mais informações sobre valores de retorno `Ref` para um recurso, consulte a documentação desse recurso na [Referência de propriedades e recursos](aws-template-resource-type-ref.md).
+ Quando você especifica uma função intrínseca, ela retorna a saída dessa função.

## Exemplos
<a name="ref-examples"></a>

### Criar referências entre recursos
<a name="intrinsic-function-reference-ref-example"></a>

A declaração de recurso a seguir para um endereço IP elástico necessita do ID de instância de uma instância do EC2. Ela usa a função `Ref` para especificar o ID da instância do recurso `MyEC2Instance` declarado em outro lugar no modelo.

#### JSON
<a name="intrinsic-function-reference-ref-example.json"></a>

```
{
  "AWSTemplateFormatVersion":"2010-09-09",
  "Resources":{
  
      ...
  
    "MyEIP":{
      "Type":"AWS::EC2::EIP",
      "Properties":{
        "InstanceId":{
          "Ref":"MyEC2Instance"
        }
      }
    }
  }
}
```

#### YAML
<a name="intrinsic-function-reference-ref-example.yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Resources:

  ...

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

### Retornar um identificador de recurso como saída da pilha
<a name="intrinsic-function-reference-ref-example-2"></a>

Os exemplos a seguir mostram como usar a função `Ref` para retornar o nome de um bucket do Amazon S3 com o nome lógico `MyBucket` como saída da pilha. 

#### JSON
<a name="intrinsic-function-reference-ref-example-2.json"></a>

```
{
  "AWSTemplateFormatVersion":"2010-09-09",
  "Resources":{
    "MyBucket":{
      "Type":"AWS::S3::Bucket",
      "Properties":{
        "BucketName":{
          "Fn::Sub": "${AWS::StackName}-mybucket"
        }
      }
    }
  },
  "Outputs":{
    "BucketNameOutput":{
      "Description":"The name of the S3 bucket",
      "Value":{
        "Ref":"MyBucket"
      }
    }
  }
}
```

#### YAML
<a name="intrinsic-function-reference-ref-example-2.yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Resources:
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: !Sub ${AWS::StackName}-mybucket

Outputs:
  BucketNameOutput:
    Description: The name of the S3 bucket
    Value: !Ref MyBucket
```

### Usar a função intrínseca `Fn::Join` dentro da função `Ref`
<a name="ref-example-intrinsic-functions-multiple-stages"></a>

**nota**  
Ao usar a transformação `AWS::LanguageExtensions`, você pode usar `Ref` em combinação com outras funções intrínsecas. Para ver as funções com suporte, consulte [Funções compatíveis](#ref-supported-functions).

Os exemplos a seguir mostram como definir identificadores de recursos usando a função intrínseca `Fn::Sub`, condições e a entrada para o parâmetro `Stage`. As funções `Ref` e `Fn::GetAtt` então fazem referência aos valores apropriados com base no estágio. `Fn::Sub` é usada primeiramente com `Fn::GetAtt` para obter o ARN da fila apropriada do Amazon SQS para definir as dimensões do alarme do Amazon CloudWatch. Em seguida, [`Fn::Join`](intrinsic-function-reference-join.md) é usada com `Ref` para criar o nome do tópico SNS para a propriedade `AlarmActions`. 

#### JSON
<a name="ref-example-intrinsic-functions-multiple-stages.json"></a>

```
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Transform": "AWS::LanguageExtensions",
    "Parameters": {
        "Stage": {
            "Type": "String",
            "Default": "Dev",
            "AllowedValues": [
                "Dev",
                "Prod"
            ]
        }
    },
    "Conditions": {
        "isProd": {
            "Fn::Equals": [
                {"Ref": "Stage"},
                "Prod"
            ]
        },
        "isDev": {
            "Fn::Equals": [
                {"Ref": "Stage"},
                "Dev"
            ]
        }
    },
    "Resources": {
        "DevQueue": {
            "Type": "AWS::SQS::Queue",
            "Condition": "isDev",
            "Properties": {
                "QueueName": {"Fn::Sub": "My${Stage}Queue"}
            }
        },
        "ProdQueue": {
            "Type": "AWS::SQS::Queue",
            "Condition": "isProd",
            "Properties": {
                "QueueName": {"Fn::Sub": "My${Stage}Queue"}
            }
        },
        "DevTopic": {
            "Condition": "isDev",
            "Type": "AWS::SNS::Topic"
        },
        "ProdTopic": {
            "Condition": "isProd",
            "Type": "AWS::SNS::Topic"
        },
        "MyAlarm": {
            "Type": "AWS::CloudWatch::Alarm",
            "Properties": {
                "AlarmDescription": "Alarm if queue depth grows beyond 10 messages",
                "Namespace": "AWS/SQS",
                "MetricName": "ApproximateNumberOfMessagesVisible",
                "Dimensions":[
                    {
                        "Name": {"Fn::Sub": "${Stage}Queue"},
                        "Value": {"Fn::GetAtt": [{"Fn::Sub": "${Stage}Queue"}, "QueueName"]}
                    }
                ],
                "Statistic": "Sum",
                "Period": 300,
                "EvaluationPeriods": 1,
                "Threshold": 10,
                "ComparisonOperator": "GreaterThanThreshold",
                "AlarmActions": [
                    {
                        "Ref": {"Fn::Join": ["", [{"Ref": "Stage"}, "Topic"]]}
                    }
                ]
            }
        }
    }
}
```

#### YAML
<a name="ref-example-intrinsic-functions-multiple-stages.yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::LanguageExtensions
Parameters:
  Stage:
    Type: String
    Default: Dev
    AllowedValues:
      - Dev
      - Prod
Conditions:
  isProd: !Equals 
    - !Ref Stage
    - Prod
  isDev: !Equals 
    - !Ref Stage
    - Dev
Resources:
  DevQueue:
    Type: AWS::SQS::Queue
    Condition: isDev
    Properties:
      QueueName: !Sub My${Stage}Queue
  ProdQueu:
    Type: AWS::SQS::Queue
    Condition: isProd
    Properties:
      QueueName: !Sub My${Stage}Queue
  DevTopic:
    Condition: isDev
    Type: AWS::SNS::Topic
  ProdTopic:
    Condition: isProd
    Type: AWS::SNS::Topic
  MyAlarm:
    Type: AWS::CloudWatch::Alarm
    Properties:
      AlarmDescription: Alarm if queue depth grows beyond 10 messages
      Namespace: AWS/SQS
      MetricName: ApproximateNumberOfMessagesVisible
      Dimensions:
        - Name: !Sub '${Stage}Queue'
          Value: !GetAtt 
            - !Sub '${Stage}Queue'
            - QueueName
      Statistic: Sum
      Period: 300
      EvaluationPeriods: 1
      Threshold: 10
      ComparisonOperator: GreaterThanThreshold
      AlarmActions:
        - !Ref 
          'Fn::Join':
            - ''
            - - !Ref Stage
              - Topic
```

## Funções compatíveis
<a name="ref-supported-functions"></a>

Quando a [transformação AWS::LanguageExtensions](transform-aws-languageextensions.md) é usada, é possível usar as funções a seguir dentro da função `Ref`.
+ [`Fn::Base64`](intrinsic-function-reference-base64.md)
+ [`Fn::FindInMap`](intrinsic-function-reference-findinmap.md)
+ [`Fn::If`](intrinsic-function-reference-conditions.md#intrinsic-function-reference-conditions-if)
+ [`Fn::ImportValue`](intrinsic-function-reference-importvalue.md)
+ [`Fn::Join`](intrinsic-function-reference-join.md)
+ [`Fn::Sub`](intrinsic-function-reference-sub.md)
+ [`Fn::ToJsonString`](intrinsic-function-reference-ToJsonString.md)
+ `Ref`