Skip to content

Add security considerations note to cfn package docs#10371

Merged
aemous merged 1 commit into
aws:developfrom
roger-zhangg:docs/cfn-package-security-considerations
Jun 4, 2026
Merged

Add security considerations note to cfn package docs#10371
aemous merged 1 commit into
aws:developfrom
roger-zhangg:docs/cfn-package-security-considerations

Conversation

@roger-zhangg

Copy link
Copy Markdown
Member

Issue #, if available:

Description of changes:
Adds a security-considerations warning to the aws cloudformation package reference documentation (rendered at https://docs.aws.amazon.com/cli/latest/reference/cloudformation/package.html, sourced from awscli/examples/cloudformation/_package_description.rst).

The note clarifies that the command treats the supplied CloudFormation template as trusted build input: properties such as CodeUri, ContentUri, TemplateURL, and the AWS::Include Location parameter cause the CLI to read files from the local filesystem at the paths the template specifies and upload them to the user-provided S3 bucket under the invoking user's AWS credentials and OS identity. Paths in the template are not constrained to the template's directory — relative paths that traverse above it (e.g. CodeUri: ../src/my-function) are supported by design for monorepo, shared-fragment, and nested-stack layouts. The note advises users not to run the command against templates from untrusted sources.

This is a documentation-only change; no behavior changes and no changelog entry is required (matching the precedent of #9316).

Generated by AI tools, and reviewed by Roger Zhang.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Add a warning callout to the `aws cloudformation package` reference
documentation clarifying that the command treats the supplied template
as trusted build input. Paths referenced by template properties such as
CodeUri, ContentUri, TemplateURL, and the AWS::Include Location are
resolved against the local filesystem and uploaded to S3 using the
invoking user's AWS credentials and OS identity, with no constraint to
the template's directory. Users should not run the command against
templates from untrusted sources.
@roger-zhangg roger-zhangg requested a review from a team as a code owner June 1, 2026 19:14
@codecov-commenter

codecov-commenter commented Jun 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.42%. Comparing base (c4681b5) to head (0bea7b9).
⚠️ Report is 395 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10371      +/-   ##
===========================================
+ Coverage    93.39%   93.42%   +0.03%     
===========================================
  Files          210      211       +1     
  Lines        17052    17312     +260     
===========================================
+ Hits         15925    16174     +249     
- Misses        1127     1138      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@aemous aemous left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for your contribution

@aemous aemous added cloudformation v1 documentation This is a problem with documentation. labels Jun 4, 2026
@aemous aemous merged commit 02a4900 into aws:develop Jun 4, 2026
41 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Jun 5, 2026
* release-1.45.24:
  Bumping version to 1.45.24
  Update changelog based on model updates
  Add security considerations note to cfn package docs (#10371)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cloudformation documentation This is a problem with documentation. v1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants