What is Ref in CloudFormation: Simple Explanation and Example

Ref in CloudFormation is a way to get the value of a resource or parameter you defined in your template. It acts like a shortcut to refer to another part of your setup, such as the name or ID of a resource, so you can use it elsewhere in your template.

How It Works

Think of Ref as a label you put on a box in your room. Instead of remembering what's inside the box, you just use the label to find it quickly. In CloudFormation, when you create resources like servers or databases, each gets a name or ID. Using Ref, you can easily point to that resource's name or ID without typing it out again.

This helps keep your template clean and flexible. If the resource's name changes, you only update it once, and everywhere you used Ref will automatically use the new value. It's like having a magic link that always knows the right answer.

Example

This example shows how Ref is used to get the name of an S3 bucket resource and use it in another part of the template.

yaml

Resources:
  MyBucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-sample-bucket

  BucketPolicy:
    Type: AWS::S3::BucketPolicy
    Properties:
      Bucket: !Ref MyBucket
      PolicyDocument:
        Statement:
          - Effect: Allow
            Principal: '*'
            Action: 's3:GetObject'
            Resource: !Sub 'arn:aws:s3:::${MyBucket}/*'

Output

Creates an S3 bucket named 'my-sample-bucket' and attaches a policy that allows public read access to objects in that bucket using the bucket's name via Ref.

When to Use

Use Ref whenever you need to reuse the value of a resource or parameter inside your CloudFormation template. For example, if you create a server and want to use its ID in a security group or a configuration, Ref helps you do that without hardcoding values.

It is especially useful when your resources depend on each other, like linking a database to an application server or setting permissions on storage buckets. This keeps your infrastructure flexible and easier to update.

Key Points

• Ref returns the value of a resource or parameter.
• It helps avoid hardcoding values in templates.
• Using Ref keeps templates flexible and easier to maintain.
• It is commonly used to get resource names, IDs, or parameter values.

Key Takeaways

Ref lets you reference resource or parameter values in CloudFormation templates.

It helps keep your infrastructure code clean and flexible by avoiding hardcoded values.

Use Ref when you want to link resources or reuse values inside your template.

It returns the logical name or ID of the resource, depending on the resource type.

Using Ref makes updating your infrastructure easier and less error-prone.