Skip to content

Commit 6a57c50

Browse files
authored
chore(cx-api): adding missing readme's (#33796)
### Issue # Closes #33795 ### Reason for this change filling in missing readme changes from PRs #33360 and #33742 ### Description of changes Added the comment wall back in, not sure what happened there. ////////////////////////////////////////////////////////////////////// Added readme's based on the ff descriptions https://github.com/aws/aws-cdk/blob/d1611f703a84faef375629dce489924ee60fab28/packages/aws-cdk-lib/cx-api/README.md?plain=1#L632-L660 ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent ab6ba09 commit 6a57c50

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

Diff for: packages/aws-cdk-lib/cx-api/README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -627,4 +627,34 @@ _cdk.json_
627627
"@aws-cdk/aws-lambda:createNewPoliciesWithAddToRolePolicy": true
628628
}
629629
}
630-
```
630+
```
631+
632+
* `@aws-cdk/aws-s3:setUniqueReplicationRoleName`
633+
634+
When this feature flag is enabled, a unique role name is specified only when performing cross-account replication.
635+
When disabled, 'CDKReplicationRole' is always specified.
636+
637+
_cdk.json_
638+
639+
```json
640+
{
641+
"context": {
642+
"@aws-cdk/aws-s3:setUniqueReplicationRoleName": true
643+
}
644+
}
645+
```
646+
647+
* `@aws-cdk/pipelines:reduceStageRoleTrustScope`
648+
649+
When this feature flag is enabled, the root account principal will not be added to the trust policy of stage role.
650+
When this feature flag is disabled, it will keep the root account principal in the trust policy.
651+
652+
_cdk.json_
653+
654+
```json
655+
{
656+
"context": {
657+
"@aws-cdk/pipelines:reduceStageRoleTrustScope": true
658+
}
659+
}
660+
```

Diff for: packages/aws-cdk-lib/cx-api/lib/features.ts

+5
Original file line numberDiff line numberDiff line change
@@ -1389,6 +1389,8 @@ export const FLAGS: Record<string, FlagInfo> = {
13891389
introducedIn: { v2: '2.178.0' },
13901390
recommendedValue: true,
13911391
},
1392+
1393+
//////////////////////////////////////////////////////////////////////
13921394
[LAMBDA_CREATE_NEW_POLICIES_WITH_ADDTOROLEPOLICY]: {
13931395
type: FlagType.BugFix,
13941396
summary: 'When enabled, Lambda will create new inline policies with AddToRolePolicy instead of adding to the Default Policy Statement',
@@ -1400,6 +1402,8 @@ export const FLAGS: Record<string, FlagInfo> = {
14001402
introducedIn: { v2: '2.180.0' },
14011403
recommendedValue: true,
14021404
},
1405+
1406+
//////////////////////////////////////////////////////////////////////
14031407
[SET_UNIQUE_REPLICATION_ROLE_NAME]: {
14041408
type: FlagType.BugFix,
14051409
summary: 'When enabled, CDK will automatically generate a unique role name that is used for s3 object replication.',
@@ -1411,6 +1415,7 @@ export const FLAGS: Record<string, FlagInfo> = {
14111415
introducedIn: { v2: '2.182.0' },
14121416
recommendedValue: true,
14131417
},
1418+
14141419
//////////////////////////////////////////////////////////////////////
14151420
[PIPELINE_REDUCE_STAGE_ROLE_TRUST_SCOPE]: {
14161421
type: FlagType.ApiDefault,

0 commit comments

Comments
 (0)