Skip to content

docs: fix wording in FEATURE_FLAGS.md for clarity #35789

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

docs: fix wording in FEATURE_FLAGS.md for clarity #35789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/cx-api/lib/features.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,10 @@ export const FLAGS: Record<string, FlagInfo> = {
detailsMd: `
When enabled, the \`signingProfileName\` property is passed to the L1 \`CfnSigningProfile\` construct,
which ensures that the AWS Signer profile is created with the specified name.

When disabled, the \`signingProfileName\` is not passed to CloudFormation, maintaining backward
compatibility with existing deployments where CloudFormation auto-generated profile names.

This feature flag is needed because enabling it can cause existing signing profiles to be
replaced during deployment if a \`signingProfileName\` was specified but not previously used
in the CloudFormation template.`,
Expand Down Expand Up @@ -659,7 +659,7 @@ export const FLAGS: Record<string, FlagInfo> = {
//////////////////////////////////////////////////////////////////////
[IAM_IMPORTED_ROLE_STACK_SAFE_DEFAULT_POLICY_NAME]: {
type: FlagType.BugFix,
summary: 'Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in.',
summary: 'Enable this feature to create default policy names for imported roles that depend on the stack the role is in.',
detailsMd: `
Without this, importing the same role in multiple places could lead to the permissions given for one version of the imported role
to overwrite permissions given to the role at a different place where it was imported. This was due to all imported instances
Expand Down
Loading