fix: give en_source_name a default value of "compliance" (#201)

Author: ocofaigh

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "go.sum|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-12-11T06:40:44Z",
+  "generated_at": "2023-12-12T06:40:44Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"

README.md

@@ -102,7 +102,7 @@ You need the following permissions to run this module.
 | <a name="input_cos_instance_crn"></a> [cos\_instance\_crn](#input\_cos\_instance\_crn) | CRN of the Cloud Object Storage to store SCC data. Required when creating a new SCC instance. | `string` | `null` | no |
 | <a name="input_en_instance_crn"></a> [en\_instance\_crn](#input\_en\_instance\_crn) | The CRN of Event Notifications instance to be used with SCC. If no value is provided, Event Notifications will not be enabled for this SCC instance | `string` | `null` | no |
 | <a name="input_en_source_description"></a> [en\_source\_description](#input\_en\_source\_description) | Optional description to give for the Event Notifications integration source. Only used if a value is passed for `en_instance_crn`. | `string` | `null` | no |
-| <a name="input_en_source_name"></a> [en\_source\_name](#input\_en\_source\_name) | The source name to use for the Event Notifications integration. Required if a value is passed for `en_instance_crn`. | `string` | `null` | no |
+| <a name="input_en_source_name"></a> [en\_source\_name](#input\_en\_source\_name) | The source name to use for the Event Notifications integration. Required if a value is passed for `en_instance_crn`. This name must be unique per SCC instance that is integrated with the Event Notfications instance. | `string` | `"compliance"` | no |
 | <a name="input_existing_scc_instance_crn"></a> [existing\_scc\_instance\_crn](#input\_existing\_scc\_instance\_crn) | The CRN of an existing Security and Compliance Center instance. If not supplied, a new instance will be created. | `string` | `null` | no |
 | <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | Name of the security and compliance instance that will be provisioned by this module | `string` | n/a | yes |
 | <a name="input_plan"></a> [plan](#input\_plan) | Pricing plan to create SCC instance. Options include security-compliance-center-standard-plan or security-compliance-center-trial-plan | `string` | `"security-compliance-center-standard-plan"` | no |

examples/complete/main.tf

@@ -68,7 +68,7 @@ module "create_scc_instance" {
   cos_bucket                        = var.existing_scc_instance_crn == null ? module.cos[0].bucket_name : null
   cos_instance_crn                  = var.existing_scc_instance_crn == null ? module.cos[0].cos_instance_id : null
   en_instance_crn                   = module.event_notification.crn
-  en_source_name                    = module.event_notification.event_notification_instance_name
+  en_source_name                    = "${var.prefix}-en-integration" # This name must be unique per SCC instance that is integrated with the Event Notfications instance.
   skip_cos_iam_authorization_policy = false
   attach_wp_to_scc_instance         = true
   skip_scc_wp_auth_policy           = false

main.tf

@@ -94,8 +94,8 @@ resource "ibm_scc_instance_settings" "scc_instance_settings" {
   instance_id = resource.ibm_resource_instance.scc_instance[0].guid
   event_notifications {
     instance_crn       = var.en_instance_crn
-    source_name        = var.en_source_name
-    source_description = var.en_source_description
+    source_name        = var.en_instance_crn != null ? var.en_source_name : null        # only pass source name if value being passed for 'en_instance_crn'
+    source_description = var.en_instance_crn != null ? var.en_source_description : null # only pass source description if value being passed for 'en_instance_crn'
   }
   object_storage {
     instance_crn = var.cos_instance_crn

variables.tf

@@ -87,8 +87,8 @@ variable "en_instance_crn" {
 
 variable "en_source_name" {
   type        = string
-  default     = null
-  description = "The source name to use for the Event Notifications integration. Required if a value is passed for `en_instance_crn`."
+  default     = "compliance"
+  description = "The source name to use for the Event Notifications integration. Required if a value is passed for `en_instance_crn`. This name must be unique per SCC instance that is integrated with the Event Notfications instance."
 }
 
 variable "en_source_description" {