align functionality with documentation

awslabs · Jan 9, 2025 · 1a924df · 1a924df
1 parent c11ceba
commit 1a924df
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 26 deletions.
diff --git a/source/packages/@aws-accelerator/accelerator/test/configs/all-enabled/global-config.yaml b/source/packages/@aws-accelerator/accelerator/test/configs/all-enabled/global-config.yaml
@@ -271,7 +271,7 @@ logging:
         categories:
           - Credentials
     firehose:
-      fileExtension: json.gz
+      fileExtension: .json.gz
     enable: true
     dynamicPartitioning: dynamic-partitioning/log-filters.json
     replaceLogDestinationArn: replaceLogDestinationArn

diff --git a/source/packages/@aws-accelerator/accelerator/test/configs/snapshot-only/global-config.yaml b/source/packages/@aws-accelerator/accelerator/test/configs/snapshot-only/global-config.yaml
@@ -206,7 +206,7 @@ logging:
         categories:
           - Credentials
     firehose:
-      fileExtension: json.gz
+      fileExtension: .json.gz
     enable: true
     replaceLogDestinationArn: arn:aws:logs:us-east-1:111111111111:destination/log-destination
     dynamicPartitioning: dynamic-partitioning/log-filters.json

diff --git a/source/packages/@aws-accelerator/config/lib/models/global-config.ts b/source/packages/@aws-accelerator/config/lib/models/global-config.ts
@@ -1091,9 +1091,9 @@ export interface ICloudWatchLogsExclusionConfig {
  * @example
  * ```
  * logging:
- *  - cloudwatchLogs:
- *  - firehose:
- *     - fileExtension: undefined | 'json.gz'
+ *   cloudwatchLogs:
+ *     firehose:
+ *       fileExtension: undefined | '.json.gz'
  *
  * ```
  */
@@ -1106,7 +1106,7 @@ export interface ICloudWatchFirehoseConfig {
    *
    * @example
    * ```
-   * - fileExtension: 'json.gz'
+   * fileExtension: '.json.gz'
    * ```
    *
    */
@@ -1167,6 +1167,8 @@ export interface ICloudWatchFirehoseConfig {
  *     deploymentTargets:
  *       organizationalUnits:
  *         - Root
+ *   firehose:
+ *     fileExtension: .json.gz
  * ```
  *
  */
@@ -1233,6 +1235,10 @@ export interface ICloudWatchLogsConfig {
    * CloudWatch Log data protection configuration
    */
   readonly dataProtection?: ICloudWatchDataProtectionConfig;
+  /**
+   * CloudWatch Firehose configuration
+   */
+  readonly firehose?: ICloudWatchFirehoseConfig
 }
 
 /**

diff --git a/source/packages/@aws-accelerator/config/validator/global-config-validator.ts b/source/packages/@aws-accelerator/config/validator/global-config-validator.ts
@@ -171,11 +171,6 @@ export class GlobalConfigValidator {
     this.validateS3ConfigDeploymentTargetOUs(values, ouIdNames, errors);
     this.validateS3ConfigDeploymentTargetAccounts(values, accountNames, errors);
 
-    //
-    // Validate File Extensions
-    //
-    this.validateFileExtensions(values);
-
     //
     // Validate region by region deploy order doesn't conflict with enabledRegions
     //
@@ -1298,21 +1293,6 @@ export class GlobalConfigValidator {
     }
   }
 
-  /**
-   * Function to validate file extensions for firehose
-   * @param values
-   */
-  private validateFileExtensions(values: GlobalConfig) {
-    if (!values.logging.cloudwatchLogs?.firehose?.fileExtension) {
-      return;
-    }
-    const fileExtension = values.logging.cloudwatchLogs?.firehose?.fileExtension;
-    if (fileExtension.startsWith('.')) {
-      const logger = createLogger(['global-config-validator-file-extension']);
-      logger.warn(`Found file extension ${fileExtension} that starts with a dot.`);
-    }
-  }
-
   /**
    * Function to validate that if region by region deployment is activated that
    * the deploy order is correctly setup.