Publishing functions
Publishing a function copies it from the DEVELOPMENT
stage to
LIVE
.
When you publish a function, all cache behaviors that are associated with the
function automatically start using the newly published copy, as soon as the
distributions finish deploying.
If no cache behaviors are associated with the function, publishing it enables you to
associate it with a cache behavior. You can only associate cache behaviors with
functions that are in the LIVE
stage.
You can publish a function in the CloudFront console or with the
AWS CLI.
Before you publish, you must test the
function.
- Console
-
To publish your function, you can use the CloudFront console. The console also
shows the CloudFront distributions that are associated with the function.
To publish a function (console)
-
To publish a function, open the Functions
page in the CloudFront console at https://console.aws.amazon.com/cloudfront/v4/home#/functions, and then choose the
function that you want to publish.
-
On the function page, choose the Publish tab.
Then choose the Publish button (or, if your
function is already attached to one or more cache behaviors, the
Publish and update button).
-
(Optional) To see the distributions that are associated with the
function, choose Associated CloudFront
distributions to expand that section.
When successful, you see a banner at the top of the page that says
Function name
published
successfully. You can also choose the
Build tab and then choose Live
to see the live version of the function code.
- CLI
-
To publish a function, run the aws cloudfront
publish-function command as shown in the example. In the
example, line breaks are provided to make the example more readable.
aws cloudfront publish-function \
--name MaxAge \
--if-match ETVXYZEXAMPLE
When the command is successful, you see output like the following.
FunctionSummary:
FunctionConfig:
Comment: Max Age 2 years
Runtime: cloudfront-js-2.0
FunctionMetadata:
CreatedTime: '2021-04-18T21:24:21.314000+00:00'
FunctionARN: arn:aws:cloudfront::111122223333:function/ExampleFunction
LastModifiedTime: '2023-12-19T23:41:15.389000+00:00'
Stage: LIVE
Name: MaxAge
Status: UNASSOCIATED