feat: add feature flag

aws · mergify · Jan 30, 2024 · Jan 10, 2024 · Jan 10, 2024 · Jan 10, 2024
commit 811d19a4166acdc4b9d65d6d97323c70c6c59c45
diff --git a/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md b/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md
@@ -63,6 +63,7 @@ Flags come in three types:
 | [@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters](#aws-cdkaws-rdsauroraclusterchangescopeofinstanceparametergroupwitheachparameters) | When enabled, a scope of InstanceParameterGroup for AuroraClusterInstance with each parameters will change. | 2.97.0 | (fix) |
 | [@aws-cdk/aws-rds:preventRenderingDeprecatedCredentials](#aws-cdkaws-rdspreventrenderingdeprecatedcredentials) | When enabled, creating an RDS database cluster from a snapshot will only render credentials for snapshot credentials. | 2.98.0 | (fix) |
 | [@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource](#aws-cdkaws-codepipeline-actionsusenewdefaultbranchforcodecommitsource) | When enabled, the CodeCommit source action is using the default branch name 'main'. | 2.103.1 | (fix) |
+| [@aws-cdk/aws-neptune-alpha:useLogTypeInLogRetentionId](#aws-cdkaws-neptune-alphauselogtypeinlogretentionid)| When enabled, the LogRetention ID includes the logtype. | V2NEXT | (fix) |
 
 <!-- END table -->
 
@@ -116,7 +117,8 @@ The following json shows the current recommended set of flags, as `cdk init` wou
     "@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters": true,
     "@aws-cdk/aws-appsync:useArnForSourceApiAssociationIdentifier": true,
     "@aws-cdk/aws-rds:preventRenderingDeprecatedCredentials": true,
-    "@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true
+    "@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true,
+    "@aws-cdk/aws-neptune-alpha:useLogTypeInLogRetentionId": true
   }
 }
 ```
@@ -1193,4 +1195,15 @@ However, with the activation of this feature flag, the default branch is updated
 | 2.103.1 | `false` | `true` |
 
 
+### @aws-cdk/aws-neptune-alpha:useLogTypeInLogRetentionId
+
+*When enabled, the log type is included in the log retention ID.* (fix)
+
+When this feature flag is enabled, setting `LogRetention` during the creation of a `DatabaseCluster` will include the `logType` in the logical ID of the generated `LogRetention`. If the flag is set to false, the logical ID of `LogRetention` will contain the string 'objectObject' regardless of the logType.
+
+| Since | Default | Recommended |
+| ----- | ----- | ----- |
+| (not in v1) |  |  |
+| V2NEXT | `false` | `true` |
+
 <!-- END details -->
diff --git a/packages/aws-cdk-lib/cx-api/lib/features.ts b/packages/aws-cdk-lib/cx-api/lib/features.ts
@@ -97,6 +97,7 @@ export const RDS_PREVENT_RENDERING_DEPRECATED_CREDENTIALS = '@aws-cdk/aws-rds:pr
 export const AURORA_CLUSTER_CHANGE_SCOPE_OF_INSTANCE_PARAMETER_GROUP_WITH_EACH_PARAMETERS = '@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters';
 export const APPSYNC_ENABLE_USE_ARN_IDENTIFIER_SOURCE_API_ASSOCIATION = '@aws-cdk/aws-appsync:useArnForSourceApiAssociationIdentifier';
 export const CODECOMMIT_SOURCE_ACTION_DEFAULT_BRANCH_NAME = '@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource';
+export const NEPTUNE_ALPHA_USE_LOG_TYPE_IN_LOG_RETENTION_ID = '@aws-cdk/aws-neptune-alpha:useLogTypeInLogRetentionId';
 
 export const FLAGS: Record<string, FlagInfo> = {
   //////////////////////////////////////////////////////////////////////
@@ -976,6 +977,19 @@ export const FLAGS: Record<string, FlagInfo> = {
     introducedIn: { v2: '2.103.1' },
     recommendedValue: true,
   },
+
+  //////////////////////////////////////////////////////////////////////
+  [NEPTUNE_ALPHA_USE_LOG_TYPE_IN_LOG_RETENTION_ID]: {
+    type: FlagType.BugFix,
+    summary: 'When enabled, the Neptune log retention ID will include the log type.',
+    detailsMd: `
+      When this feature flag is enabled, setting \`LogRetention\` during the creation of a \`DatabaseCluster\` 
+      will include the \`logType\` in the logical ID of the generated \`LogRetention\`.
+      If the flag is set to false, the logical ID of \`LogRetention\` will contain the string 'objectObject' regardless of the logType.
+    `,
+    introducedIn: { v2: 'V2NEXT' },
+    recommendedValue: true,
+  },
 };
 
 const CURRENT_MV = 'v2';