Skip to content

Commit 83dc73c

Browse files
kaizencckaizencc
authored
chore(cx-api): feature flags are documented incorrectly (#25994)
```ts // !!! IMPORTANT !!! // // When you introduce a new flag, set its 'introducedIn.v2' value to the literal string // 'V2·NEXT', without the dot. // // DO NOT USE A VARIABLE. DO NOT DEFINE A CONSTANT. The actual value will be string-replaced at // version bump time. ``` Well, this proved to be difficult. Some places we supplied `V2·NEXT`, _with_ the dot. This PR manually updates everything back to when they were released, because we've missed the boat on the magic V2NEXT updates. cc @corymhall for visibility, since you and I were the culprits and I was copying you :) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 9018a16 commit 83dc73c

File tree

2 files changed

+84
-84
lines changed

2 files changed

+84
-84
lines changed

‎packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md

Lines changed: 80 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ Flags come in three types:
1717

1818
| Flag | Summary | Since | Type |
1919
| ----- | ----- | ----- | ----- |
20-
| [@aws-cdk/aws-apigateway:requestValidatorUniqueId](#aws-cdkaws-apigatewayrequestvalidatoruniqueid) | Generate a unique id for each RequestValidator added to a method | V2·NEXT | (fix) |
21-
| [@aws-cdk/aws-ec2:restrictDefaultSecurityGroup](#aws-cdkaws-ec2restrictdefaultsecuritygroup) | Restrict access to the VPC default security group | V2·NEXT | (default) |
22-
| [@aws-cdk/aws-kms:aliasNameRef](#aws-cdkaws-kmsaliasnameref) | KMS Alias name and keyArn will have implicit reference to KMS Key | V2·NEXT | (fix) |
23-
| [@aws-cdk/aws-route53-patters:useCertificate](#aws-cdkaws-route53-pattersusecertificate) | Use the official `Certificate` resource instead of `DnsValidatedCertificate` | V2·NEXT | (default) |
2420
| [@aws-cdk/core:newStyleStackSynthesis](#aws-cdkcorenewstylestacksynthesis) | Switch to new stack synthesis method which enables CI/CD | 2.0.0 | (fix) |
2521
| [@aws-cdk/core:stackRelativeExports](#aws-cdkcorestackrelativeexports) | Name exports based on the construct paths relative to the stack, rather than the global construct path | 2.0.0 | (fix) |
2622
| [@aws-cdk/aws-rds:lowercaseDbIdentifier](#aws-cdkaws-rdslowercasedbidentifier) | Force lowercasing of RDS Cluster names in CDK | 2.0.0 | (fix) |
@@ -46,13 +42,17 @@ Flags come in three types:
4642
| [@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName](#aws-cdkaws-iamimportedrolestacksafedefaultpolicyname) | Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in. | 2.60.0 | (fix) |
4743
| [@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy](#aws-cdkaws-s3serveraccesslogsusebucketpolicy) | Use S3 Bucket Policy instead of ACLs for Server Access Logging | 2.60.0 | (fix) |
4844
| [@aws-cdk/customresources:installLatestAwsSdkDefault](#aws-cdkcustomresourcesinstalllatestawssdkdefault) | Whether to install the latest SDK by default in AwsCustomResource | 2.60.0 | (default) |
45+
| [@aws-cdk/aws-route53-patters:useCertificate](#aws-cdkaws-route53-pattersusecertificate) | Use the official `Certificate` resource instead of `DnsValidatedCertificate` | 2.61.0 | (default) |
4946
| [@aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup](#aws-cdkaws-codedeployremovealarmsfromdeploymentgroup) | Remove CloudWatch alarms from deployment group | 2.65.0 | (fix) |
5047
| [@aws-cdk/aws-rds:databaseProxyUniqueResourceName](#aws-cdkaws-rdsdatabaseproxyuniqueresourcename) | Use unique resource name for Database Proxy | 2.65.0 | (fix) |
5148
| [@aws-cdk/aws-apigateway:authorizerChangeDeploymentLogicalId](#aws-cdkaws-apigatewayauthorizerchangedeploymentlogicalid) | Include authorizer configuration in the calculation of the API deployment logical ID. | 2.66.0 | (fix) |
5249
| [@aws-cdk/aws-ec2:launchTemplateDefaultUserData](#aws-cdkaws-ec2launchtemplatedefaultuserdata) | Define user data for a launch template by default when a machine image is provided. | 2.67.0 | (fix) |
5350
| [@aws-cdk/aws-secretsmanager:useAttachedSecretResourcePolicyForSecretTargetAttachments](#aws-cdkaws-secretsmanageruseattachedsecretresourcepolicyforsecrettargetattachments) | SecretTargetAttachments uses the ResourcePolicy of the attached Secret. | 2.67.0 | (fix) |
5451
| [@aws-cdk/aws-redshift:columnId](#aws-cdkaws-redshiftcolumnid) | Whether to use an ID to track Redshift column changes | 2.68.0 | (fix) |
5552
| [@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2](#aws-cdkaws-stepfunctions-tasksenableemrservicepolicyv2) | Enable AmazonEMRServicePolicy_v2 managed policies | 2.72.0 | (fix) |
53+
| [@aws-cdk/aws-apigateway:requestValidatorUniqueId](#aws-cdkaws-apigatewayrequestvalidatoruniqueid) | Generate a unique id for each RequestValidator added to a method | 2.78.0 | (fix) |
54+
| [@aws-cdk/aws-ec2:restrictDefaultSecurityGroup](#aws-cdkaws-ec2restrictdefaultsecuritygroup) | Restrict access to the VPC default security group | 2.78.0 | (default) |
55+
| [@aws-cdk/aws-kms:aliasNameRef](#aws-cdkaws-kmsaliasnameref) | KMS Alias name and keyArn will have implicit reference to KMS Key | 2.83.0 | (fix) |
5656
| [@aws-cdk/core:includePrefixInUniqueNameGeneration](#aws-cdkcoreincludeprefixinuniquenamegeneration) | Include the stack prefix in the stack name generation process | 2.84.0 | (fix) |
5757

5858
<!-- END table -->
@@ -328,82 +328,6 @@ Encryption can also be configured explicitly using the `encrypted` property.
328328
**Compatibility with old behavior:** Pass the `encrypted: false` property to the `FileSystem` construct to disable encryption.
329329

330330

331-
### @aws-cdk/aws-apigateway:requestValidatorUniqueId
332-
333-
*Generate a unique id for each RequestValidator added to a method* (fix)
334-
335-
This flag allows multiple RequestValidators to be added to a RestApi when
336-
providing the `RequestValidatorOptions` in the `addMethod()` method.
337-
338-
If the flag is not set then only a single RequestValidator can be added in this way.
339-
Any additional RequestValidators have to be created directly with `new RequestValidator`.
340-
341-
342-
| Since | Default | Recommended |
343-
| ----- | ----- | ----- |
344-
| (not in v1) | | |
345-
| V2·NEXT | `false` | `true` |
346-
347-
348-
### @aws-cdk/aws-ec2:restrictDefaultSecurityGroup
349-
350-
*Restrict access to the VPC default security group* (default)
351-
352-
Enable this feature flag to remove the default ingress/egress rules from the
353-
VPC default security group.
354-
355-
When a VPC is created, a default security group is created as well and this cannot
356-
be deleted. The default security group is created with ingress/egress rules that allow
357-
_all_ traffic. [AWS Security best practices recommend](https://docs.aws.amazon.com/securityhub/latest/userguide/ec2-controls.html#ec2-2)
358-
removing these ingress/egress rules in order to restrict access to the default security group.
359-
360-
361-
| Since | Default | Recommended |
362-
| ----- | ----- | ----- |
363-
| (not in v1) | | |
364-
| V2·NEXT | `false` | `true` |
365-
366-
**Compatibility with old behavior:**
367-
To allow all ingress/egress traffic to the VPC default security group you
368-
can set the `restrictDefaultSecurityGroup: false`.
369-
370-
371-
372-
### @aws-cdk/aws-kms:aliasNameRef
373-
374-
*KMS Alias name and keyArn will have implicit reference to KMS Key* (fix)
375-
376-
This flag allows an implicit dependency to be created between KMS Alias and KMS Key
377-
when referencing key.aliasName or key.keyArn.
378-
379-
If the flag is not set then a raw string is passed as the Alias name and no
380-
implicit dependencies will be set.
381-
382-
383-
| Since | Default | Recommended |
384-
| ----- | ----- | ----- |
385-
| (not in v1) | | |
386-
| V2·NEXT | `false` | `true` |
387-
388-
389-
### @aws-cdk/aws-route53-patters:useCertificate
390-
391-
*Use the official `Certificate` resource instead of `DnsValidatedCertificate`* (default)
392-
393-
Enable this feature flag to use the official CloudFormation supported `Certificate` resource instead
394-
of the deprecated `DnsValidatedCertificate` construct. If this flag is enabled and you are creating
395-
the stack in a region other than us-east-1 then you must also set `crossRegionReferences=true` on the
396-
stack.
397-
398-
399-
| Since | Default | Recommended |
400-
| ----- | ----- | ----- |
401-
| (not in v1) | | |
402-
| V2·NEXT | `false` | `true` |
403-
404-
**Compatibility with old behavior:** Define a `DnsValidatedCertificate` explicitly and pass in the `certificate` property
405-
406-
407331
### @aws-cdk/core:newStyleStackSynthesis
408332

409333
*Switch to new stack synthesis method which enables CI/CD* (fix)
@@ -858,6 +782,24 @@ flag on a resource-by-resource basis to enable it if necessary.
858782
**Compatibility with old behavior:** Set installLatestAwsSdk: true on all resources that need it.
859783

860784

785+
### @aws-cdk/aws-route53-patters:useCertificate
786+
787+
*Use the official `Certificate` resource instead of `DnsValidatedCertificate`* (default)
788+
789+
Enable this feature flag to use the official CloudFormation supported `Certificate` resource instead
790+
of the deprecated `DnsValidatedCertificate` construct. If this flag is enabled and you are creating
791+
the stack in a region other than us-east-1 then you must also set `crossRegionReferences=true` on the
792+
stack.
793+
794+
795+
| Since | Default | Recommended |
796+
| ----- | ----- | ----- |
797+
| (not in v1) | | |
798+
| 2.61.0 | `false` | `true` |
799+
800+
**Compatibility with old behavior:** Define a `DnsValidatedCertificate` explicitly and pass in the `certificate` property
801+
802+
861803
### @aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup
862804

863805
*Remove CloudWatch alarms from deployment group* (fix)
@@ -988,6 +930,64 @@ intervention since they might not have the appropriate tags propagated automatic
988930
| 2.72.0 | `false` | `true` |
989931

990932

933+
### @aws-cdk/aws-apigateway:requestValidatorUniqueId
934+
935+
*Generate a unique id for each RequestValidator added to a method* (fix)
936+
937+
This flag allows multiple RequestValidators to be added to a RestApi when
938+
providing the `RequestValidatorOptions` in the `addMethod()` method.
939+
940+
If the flag is not set then only a single RequestValidator can be added in this way.
941+
Any additional RequestValidators have to be created directly with `new RequestValidator`.
942+
943+
944+
| Since | Default | Recommended |
945+
| ----- | ----- | ----- |
946+
| (not in v1) | | |
947+
| 2.78.0 | `false` | `true` |
948+
949+
950+
### @aws-cdk/aws-ec2:restrictDefaultSecurityGroup
951+
952+
*Restrict access to the VPC default security group* (default)
953+
954+
Enable this feature flag to remove the default ingress/egress rules from the
955+
VPC default security group.
956+
957+
When a VPC is created, a default security group is created as well and this cannot
958+
be deleted. The default security group is created with ingress/egress rules that allow
959+
_all_ traffic. [AWS Security best practices recommend](https://docs.aws.amazon.com/securityhub/latest/userguide/ec2-controls.html#ec2-2)
960+
removing these ingress/egress rules in order to restrict access to the default security group.
961+
962+
963+
| Since | Default | Recommended |
964+
| ----- | ----- | ----- |
965+
| (not in v1) | | |
966+
| 2.78.0 | `false` | `true` |
967+
968+
**Compatibility with old behavior:**
969+
To allow all ingress/egress traffic to the VPC default security group you
970+
can set the `restrictDefaultSecurityGroup: false`.
971+
972+
973+
974+
### @aws-cdk/aws-kms:aliasNameRef
975+
976+
*KMS Alias name and keyArn will have implicit reference to KMS Key* (fix)
977+
978+
This flag allows an implicit dependency to be created between KMS Alias and KMS Key
979+
when referencing key.aliasName or key.keyArn.
980+
981+
If the flag is not set then a raw string is passed as the Alias name and no
982+
implicit dependencies will be set.
983+
984+
985+
| Since | Default | Recommended |
986+
| ----- | ----- | ----- |
987+
| (not in v1) | | |
988+
| 2.83.0 | `false` | `true` |
989+
990+
991991
### @aws-cdk/core:includePrefixInUniqueNameGeneration
992992

993993
*Include the stack prefix in the stack name generation process* (fix)

‎packages/aws-cdk-lib/cx-api/lib/features.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,7 @@ export const FLAGS: Record<string, FlagInfo> = {
617617
the stack in a region other than us-east-1 then you must also set \`crossRegionReferences=true\` on the
618618
stack.
619619
`,
620-
introducedIn: { v2: 'V2·NEXT' },
620+
introducedIn: { v2: '2.61.0' },
621621
recommendedValue: true,
622622
compatibilityWithOldBehaviorMd: 'Define a `DnsValidatedCertificate` explicitly and pass in the `certificate` property',
623623
},
@@ -768,7 +768,7 @@ export const FLAGS: Record<string, FlagInfo> = {
768768
_all_ traffic. [AWS Security best practices recommend](https://docs.aws.amazon.com/securityhub/latest/userguide/ec2-controls.html#ec2-2)
769769
removing these ingress/egress rules in order to restrict access to the default security group.
770770
`,
771-
introducedIn: { v2: 'V2·NEXT' },
771+
introducedIn: { v2: '2.78.0' },
772772
recommendedValue: true,
773773
compatibilityWithOldBehaviorMd: `
774774
To allow all ingress/egress traffic to the VPC default security group you
@@ -787,7 +787,7 @@ export const FLAGS: Record<string, FlagInfo> = {
787787
If the flag is not set then only a single RequestValidator can be added in this way.
788788
Any additional RequestValidators have to be created directly with \`new RequestValidator\`.
789789
`,
790-
introducedIn: { v2: 'V2·NEXT' },
790+
introducedIn: { v2: '2.78.0' },
791791
recommendedValue: true,
792792
},
793793

@@ -802,7 +802,7 @@ export const FLAGS: Record<string, FlagInfo> = {
802802
If the flag is not set then a raw string is passed as the Alias name and no
803803
implicit dependencies will be set.
804804
`,
805-
introducedIn: { v2: 'V2·NEXT' },
805+
introducedIn: { v2: '2.83.0' },
806806
recommendedValue: true,
807807
},
808808

0 commit comments

Comments
 (0)