Refer to resource outputs in another CloudFormation stack
This walkthrough shows you how to reference outputs from one CloudFormation stack within another stack to create more modular and reusable templates.
Instead of including all resources in a single stack, you create related AWS resources in separate stacks. Then, you can refer to required resource outputs from other stacks. By restricting cross-stack references to outputs, you control the parts of a stack that are referenced by other stacks.
For example, you might have a network stack with a VPC, a security group, and a subnet for public web applications, and a separate public web application stack. To ensure that the web applications use the security group and subnet from the network stack, you create a cross-stack reference that allows the web application stack to reference resource outputs from the network stack. With a cross-stack reference, owners of the web application stacks don't need to create or maintain networking rules or assets.
To create a cross-stack reference, use the Export
output field to flag the
value of a resource output for export. Then, use the Fn::ImportValue
intrinsic
function to import the value. For more information, see Get exported outputs from a deployed CloudFormation
stack.
Note
CloudFormation is a free service. However, you are charged for the AWS resources that you
include in your stacks at the current rate for each one. For more information about AWS
pricing, see the detail page for each product
Step 1: Use a sample template to create a network stack
Before you begin this walkthrough, check that you have IAM permissions to use all of the following services: Amazon VPC, Amazon EC2, and CloudFormation.
The network stack contains the VPC, security group, and subnet that you will use in the web application stack. In addition to these resources, the network stack creates an Internet gateway and routing tables to enable public access.
You must create this stack before you create the web application stack. If you create the web application stack first, it won't have a security group or subnet.
The stack template is available from the following URL: https://s3.amazonaws.com/cloudformation-examples/user-guide/cross-stack/SampleNetworkCrossStack.templateOutputs
section, you can see the networking resources that the sample
template exports. The names of the exported resources are prefixed with the stack's name in
case you export networking resources from other stacks. When users import networking
resources, they can specify from which stack the resources are imported.
To create the network stack
-
Open the CloudFormation console
and choose Create stack. -
Choose Template is ready, and in the Specify template section choose Amazon S3 URL.
-
Copy and paste the following URL into the text box:
https://s3.amazonaws.com/cloudformation-examples/user-guide/cross-stack/SampleNetworkCrossStack.template
. -
Choose Next.
-
For Stack name, type
SampleNetworkCrossStack
, and then choose Next.Note
Record the name of this stack. You'll need the stack name when you launch the web application stack.
-
Choose Next. For this walkthrough, you don't need to add tags or specify advanced settings.
-
Ensure that the stack name and template URL are correct, and then choose Create stack.
It might take several minutes for CloudFormation to create your stack. Wait until all resources have been successfully created before proceeding to create the web application stack.
-
To monitor progress, view the stack events. For more information, see Monitor stack progress.
Step 2: Use a sample template to create a web application stack
The web application stack creates an EC2 instance that uses the security group and subnet from the network stack.
You must create this stack in the same AWS Region as the network stack.
The stack template is available from the following URL: https://s3.amazonaws.com/cloudformation-examples/user-guide/cross-stack/SampleWebAppCrossStack.templateResources
section, view the EC2 instance's properties. You can
see how the networking resources are imported from another stack by using the
Fn::ImportValue
function.
To create the web application stack
-
Open the CloudFormation console
, and choose Create stack. -
Choose Template is ready, and in the Specify template section choose Amazon S3 URL.
-
Copy and paste the following URL into the text box:
https://s3.amazonaws.com/cloudformation-examples/user-guide/cross-stack/SampleWebAppCrossStack.template
. -
Choose Next.
-
For Stack name, type
SampleWebAppCrossStack
. In the Parameters section, use the default value for the NetworkStackName parameter, and then choose Next.The sample template uses the parameter value to specify from which stack to import values.
-
Choose Next. For this walkthrough, you don't need to add tags or specify advanced settings.
-
Ensure that the stack name and template URL are correct, and then choose Create stack.
It might take several minutes for CloudFormation to create your stack.
Step 3: Verify the stack works as designed
After the stack has been created, view its resources and note the instance ID. For more information on viewing stack resources, see View stack information from the CloudFormation console.
To verify the instance's security group and subnet, view the instance's properties in
the Amazon EC2 consoleSampleNetworkCrossStack
stack, you have
successfully created a cross-stack reference.
Use the console to view the stack outputs and the example website URL to verify that the web application is running. For more information, see View stack information from the CloudFormation console.
Step 4: Clean up your resources
To ensure that you are not charged for unwanted services, delete the stacks.
To delete the stacks
-
In the CloudFormation console, choose the
SampleWebAppCrossStack
stack. -
Choose Actions, and then choose Delete stack.
-
In the confirmation message, choose Delete.
-
After the stack has been deleted, repeat the same steps for the
SampleNetworkCrossStack
stack.Note
Wait until CloudFormation completely deletes the
SampleWebAppCrossStack
stack. If the EC2 instance is still running in the VPC, CloudFormation won't delete the VPC in theSampleNetworkCrossStack
stack.