allow currency selection (#1174)

Author: iakov-gan

cfn-templates/cid-cfn.yml

@@ -1,5 +1,5 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Deployment of Cloud Intelligence Dashboards v4.1.3
+Description: Deployment of Cloud Intelligence Dashboards v4.1.4
 Metadata:
   AWS::CloudFormation::Interface:
     ParameterGroups:
@@ -104,6 +104,8 @@ Metadata:
         default: "Create Local Assets Bucket"
       ReferenceAssetsBucket:
         default: "Reference Assets Bucket Name"
+      CurrencySymbol:
+        default: "Currency Symbol"
   cfn-lint:
     config:
       ignore_checks:
@@ -256,6 +258,20 @@ Parameters:
     Type: String
     Description: Source bucket for CID Assets to sync from.
     Default: 'aws-managed-cost-intelligence-dashboards-us-east-1'
+  CurrencySymbol:
+    Type: String
+    Description: 'Currency Symbol. Please align with Currency of your CUR. Only supported for China region.'
+    Default: "USD"
+    AllowedValues: 
+      # Only currency symbols supported by QS
+      - "USD" # US Dollar         $
+      - "GBP" # British Pound     £
+      - "EUR" # Euro              €
+      - "JPY" # Japanese Yen      ¥
+      - "KRW" # South Korean Won  ₩
+      - "DKK" # Danish Krone      kr
+      - "TWD" # Taiwan Dollar     NT
+      - "INR" # Indian Rupee      ₹
 
 Conditions:
   NeedCUDOSDashboard: !Equals [ !Ref DeployCUDOSDashboard, "yes" ]
@@ -1789,7 +1805,7 @@ Resources:
               try:
                   dashboard = properties['Dashboard']
                   # set additional parameters from environment variables
-                  for par in 'athena_workgroup quicksight_datasource_id quicksight_datasource_role_arn athena_database glue_data_catalog cur_table_name cur_database quicksight_user account_map_source share_with_account account_map_database_name'.split():
+                  for par in 'athena_workgroup quicksight_datasource_id quicksight_datasource_role_arn athena_database glue_data_catalog cur_table_name cur_database quicksight_user account_map_source share_with_account account_map_database_name currency_symbol'.split():
                       dashboard[par.replace('_', '-')] = dashboard.get(par.replace('_', '-'), os.environ.get(par))
                   if request_type == 'Create':
                       dash_url = deploy_dash(dashboard)
@@ -1864,6 +1880,7 @@ Resources:
           account_map_source: 'dummy' #initial
           share_with_account: !Ref ShareDashboard
           account_map_database_name: !If [NeedDatabase, !Ref CidDatabase, !Ref DatabaseName ]
+          currency_symbol: !Ref CurrencySymbol
     Metadata:
       cfn_nag:
         rules_to_suppress:
@@ -2052,7 +2069,7 @@ Resources:
       SourceBucket: !Ref ReferenceAssetsBucket
       DestinationBucket: !Ref LocalAssetsBucket
       Keys:
-        - 'cid-resource-lambda-layer/cid-4.1.3.zip' #replace version here if needed
+        - 'cid-resource-lambda-layer/cid-4.1.4.zip' #replace version here if needed
 
   CidResourceLambdaLayer:
     Type: AWS::Lambda::LayerVersion
@@ -2067,7 +2084,7 @@ Resources:
             - LambdaLayerBucketPrefixIsManaged
             - !FindInMap [RegionMap, !Ref 'AWS::Region', BucketName]
             - !Sub '${LambdaLayerBucketPrefix}-${AWS::Region}' # Region added for backward compatibility
-        S3Key: 'cid-resource-lambda-layer/cid-4.1.3.zip' #replace version here if needed
+        S3Key: 'cid-resource-lambda-layer/cid-4.1.4.zip' #replace version here if needed
       CompatibleRuntimes:
         - python3.10
         - python3.11

cid/_version.py

@@ -1,2 +1,2 @@
-__version__ = '4.1.3'
+__version__ = '4.1.4'
 

cid/cli.py

@@ -140,6 +140,7 @@ def deploy(ctx, **kwargs):
      --category TEXT                       Comma separated list of categories of dashboards (ex: foundational,advanced )
      --catalog TEXT                        Comma separated list of catalog files or urls (ex: foundational,advanced )
      --theme TEXT                          A QuickSight Theme (CLASSIC|MIDNIGHT|SEASIDE|RAINIER)
+     --currency TEXT                       A currency symbol instead of default USD (USD|GBP|EUR|JPY|KRW|DKK|TWD|INR)
      --share-with-account  (yes|no)        Make dashboard visible to other users in the same account by default.
      """
     ctx.obj.deploy(**kwargs)
@@ -206,6 +207,7 @@ def update(ctx, dashboard_id, force, recursive, **kwargs):
     \b
      --on-drift (show|override)            Action if a drift of view and dataset is discovered. 'override' = override drift(will destroy customization) or 'show' (default) = show a diff. In Unattended mode (without terminal on-drift will have allways override behaviour)
      --theme TEXT                          A QuickSight Theme (CLASSIC|MIDNIGHT|SEASIDE|RAINIER)
+     --currency TEXT                       A currency symbol instead of default USD (USD|GBP|EUR|JPY|KRW|DKK|TWD|INR)
 
     """
     ctx.obj.update(dashboard_id, force=force, recursive=recursive, **kwargs)

cid/helpers/quicksight/__init__.py

@@ -1301,6 +1301,21 @@ def _build_params_for_create_update_dash(self, definition: dict, permissions: bo
             }
         elif definition.get('definition'):
             create_parameters['Definition'] = definition.get('definition')
+            currency = get_parameters().get('currency-symbol', 'USD')
+            if currency != 'USD' and currency:
+                if currency not in "USD|GBP|EUR|JPY|KRW|DKK|TWD|INR".split('|'):
+                    raise CidCritical(f'Currency {currency} is not supported. USD|GBP|EUR|JPY|KRW|DKK|TWD|INR')
+                cid_print(f'Setting currency = <BOLD>{currency}<END>')
+                def _set_currency(data):
+                    """Recursively set currency"""
+                    if isinstance(data, dict):
+                        if 'CurrencyDisplayFormatConfiguration' in data:
+                            data['CurrencyDisplayFormatConfiguration']['Symbol'] = currency
+                        return {k: _set_currency(v) for k, v in data.items()}
+                    elif isinstance(data, list):
+                        return [_set_currency(item) for item in data]
+                    return data
+                create_parameters['Definition'] = _set_currency(create_parameters['Definition'])
             dataset_references = []
             for identifier, arn in definition.get('datasets', {}).items():
                 # Fetch dataset by name (preferably) OR by id