-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add Cloudfront invalidation example for S3 deployment #12238
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7a1e634
Add cloudfront invalidation example for S3 deployment
GibzonDev 0fa443c
Apply suggestions from code review
GibzonDev 6b1b962
Limit invalidate cache permissions and set runOrder
GibzonDev 3cbdda7
Minor style changes
skinny85 6eb4734
Merge branch 'master' into master
mergify[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -689,6 +689,70 @@ const deployStage = pipeline.addStage({ | |
}); | ||
``` | ||
|
||
#### Invalidating the CloudFront cache when deploying to S3 | ||
|
||
There is currently no native support in CodePipeline for invalidating a CloudFront cache after deployment. | ||
One workaround is to add another build step after the deploy step, | ||
and use the AWS CLI to invalidate the cache: | ||
|
||
```ts | ||
// Create a Cloudfront Web Distribution | ||
const distribution = new cloudfront.Distribution(this, `Distribution`, { | ||
// ... | ||
}); | ||
|
||
// Create the build project that will invalidate the cache | ||
const invalidateBuildProject = new codebuild.PipelineProject(this, `InvalidateProject`, { | ||
buildSpec: codebuild.BuildSpec.fromObject({ | ||
version: '0.2', | ||
phases: { | ||
build: { | ||
commands:[ | ||
'aws cloudfront create-invalidation --distribution-id ${CLOUDFRONT_ID} --paths "/*"', | ||
// Choose whatever files or paths you'd like, or all files as specified here | ||
], | ||
}, | ||
}, | ||
}), | ||
environmentVariables: { | ||
CLOUDFRONT_ID: { value: distribution.distributionId }, | ||
}, | ||
}); | ||
|
||
// Add Cloudfront invalidation permissions to the project | ||
const distributionArn = `arn:aws:cloudfront::${this.account}:distribution/${distribution.distributionId}`; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe use |
||
invalidateBuildProject.addToRolePolicy(new iam.PolicyStatement({ | ||
resources: [distributionArn], | ||
actions: [ | ||
'cloudfront:CreateInvalidation', | ||
], | ||
})); | ||
|
||
// Create the pipeline (here only the S3 deploy and Invalidate cache build) | ||
new codepipeline.Pipeline(this, 'Pipeline', { | ||
stages: [ | ||
// ... | ||
{ | ||
stageName: 'Deploy', | ||
actions: [ | ||
new codepipelineActions.S3DeployAction({ | ||
actionName: 'S3Deploy', | ||
bucket: deployBucket, | ||
input: deployInput, | ||
runOrder: 1, | ||
}), | ||
new codepipelineActions.CodeBuildAction({ | ||
actionName: 'InvalidateCache', | ||
project: invalidateBuildProject, | ||
input: deployInput, | ||
runOrder: 2, | ||
}), | ||
], | ||
}, | ||
], | ||
}); | ||
``` | ||
|
||
### Alexa Skill | ||
|
||
You can deploy to Alexa using CodePipeline with the following Action: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add necessary additional import of
import * as iam from '@aws-cdk/aws-iam'