You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: updated few input-ouput variables description and catalog content (content review) (#533)
* Update ibm_catalog.json
* Update variables.tf
* minor updates
* test: skipping TestDependencyPermutations test for now
* test: skipping TestDependencyPermutations test for now
* test: skipping TestDependencyPermutations test for now
---------
Co-authored-by: Akash Kumar <Ak-sky@users.noreply.github.com>
Co-authored-by: Akash Kumar <akash.kumar@ibm.com>
Co-authored-by: Shikha Maheshwari <maheshwari.shikha@gmail.com>
| <aname="input_access_tags"></a> [access\_tags](#input\_access\_tags)| A list of access tags to apply to the Event Notifications instance created by the module. For more information, see https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial.|`list(string)`|`[]`| no |
100
+
| <aname="input_access_tags"></a> [access\_tags](#input\_access\_tags)| A list of access tags to apply to the Event Notifications instance created by the module. [Learn more](https://cloud.ibm.com/docs/account?topic=account-access-tags-tutorial). |`list(string)`|`[]`| no |
101
101
| <aname="input_cbr_rules"></a> [cbr\_rules](#input\_cbr\_rules)| The list of context-based restrictions rules to create. | <pre>list(object({<br/> description = string<br/> account_id = string<br/> rule_contexts = list(object({<br/> attributes = optional(list(object({<br/> name = string<br/> value = string<br/> }))) }))<br/> enforcement_mode = string<br/> operations = optional(list(object({<br/> api_types = list(object({<br/> api_type_id = string<br/> }))<br/> })))<br/> }))</pre> |`[]`| no |
102
-
| <aname="input_cos_bucket_name"></a> [cos\_bucket\_name](#input\_cos\_bucket\_name)| The name of an existing IBM Cloud Object Storage bucket which will be used for storage of failed delivery events. Required if `cos_integration_enabled` is set to true. |`string`|`null`| no |
103
-
| <aname="input_cos_endpoint"></a> [cos\_endpoint](#input\_cos\_endpoint)| The endpoint URL for your bucket region. For more information, see https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints. Required if `cos_integration_enabled` is set to true. |`string`|`null`| no |
104
-
| <aname="input_cos_instance_id"></a> [cos\_instance\_id](#input\_cos\_instance\_id)| The ID of the IBM Cloud Object Storage instance in which the bucket that is defined in the `cos_bucket_name` variable exists. Required if `cos_integration_enabled` is set to true. |`string`|`null`| no |
105
-
| <aname="input_cos_integration_enabled"></a> [cos\_integration\_enabled](#input\_cos\_integration\_enabled)| Set to `true` to connect a Cloud Object Storage service instance to your Event Notifications instance to collect events that failed delivery. If set to false, no failed events will be captured. |`bool`|`false`| no |
102
+
| <aname="input_cos_bucket_name"></a> [cos\_bucket\_name](#input\_cos\_bucket\_name)| The name of an existing IBM Cloud Object Storage bucket to use for storing failed delivery events. Required if `cos_integration_enabled` is set to `true`. |`string`|`null`| no |
103
+
| <aname="input_cos_endpoint"></a> [cos\_endpoint](#input\_cos\_endpoint)| The endpoint URL for your bucket region. Required if `cos_integration_enabled` is set to `true`. [Learn more](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints). |`string`|`null`| no |
104
+
| <aname="input_cos_instance_id"></a> [cos\_instance\_id](#input\_cos\_instance\_id)| The ID of an existing IBM Cloud Object Storage instance that contains the bucket to use for storing failed delivery events. Required if `cos_integration_enabled` is set to `true`. |`string`|`null`| no |
105
+
| <aname="input_cos_integration_enabled"></a> [cos\_integration\_enabled](#input\_cos\_integration\_enabled)| Set to `true` to connect an Object Storage service instance to your Event Notifications instance to collect events that failed delivery. If set to false, no failed events are captured. |`bool`|`false`| no |
106
106
| <aname="input_existing_kms_instance_crn"></a> [existing\_kms\_instance\_crn](#input\_existing\_kms\_instance\_crn)| The CRN of the Hyper Protect Crypto Services or Key Protect instance. Required only if `var.kms_encryption_enabled` is set to `true`. |`string`|`null`| no |
107
107
| <aname="input_kms_encryption_enabled"></a> [kms\_encryption\_enabled](#input\_kms\_encryption\_enabled)| Set to `true` to control the encryption keys that are used to encrypt the data that you store in the Event Notifications instance. If set to `false`, the data is encrypted by using randomly generated keys. For more information, see [Managing encryption](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-managing-encryption). |`bool`|`false`| no |
108
-
| <aname="input_kms_endpoint_url"></a> [kms\_endpoint\_url](#input\_kms\_endpoint\_url)| The URL of the KMS endpoint to use when configuring KMS encryption. The Hyper Protect Crypto Services endpoint URL format can be found at https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-regions#new-service-endpoints, and the Key Protect endpoint URL format can be found here https://cloud.ibm.com/docs/key-protect?topic=key-protect-regions#service-endpoints.|`string`|`null`| no |
108
+
| <aname="input_kms_endpoint_url"></a> [kms\_endpoint\_url](#input\_kms\_endpoint\_url)| The URL of the key management service endpoint to use for key encryption. For more information on the endpoint URL format for Hyper Protect Crypto Services, go to [Instance-based endpoints](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-regions#new-service-endpoints). For more information on the endpoint URL format for Key Protect, go to [Service endpoints](https://cloud.ibm.com/docs/key-protect?topic=key-protect-regions#service-endpoints). |`string`|`null`| no |
109
109
| <aname="input_name"></a> [name](#input\_name)| The name of the Event Notifications instance that is created by this module. |`string`| n/a | yes |
110
-
| <aname="input_plan"></a> [plan](#input\_plan)| The pricing plan of the Event Notifications instance. Possible values: `Lite`, `Standard`|`string`|`"standard"`| no |
111
-
| <aname="input_region"></a> [region](#input\_region)| The IBM Cloud region where the Event Notifications resource is created. Possible values: `jp-osa` (Osaka), `au-syd` (Sydney), `jp-tok` (Tokyo), `eu-de` (Frankfurt), `eu-gb` (London), `eu-es` (Madrid), `eu-fr2` (BNPP), `us-south` (Dallas), `ca-tor` (Toronto), `br-sao` (Sao Paulo) |`string`|`"us-south"`| no |
110
+
| <aname="input_plan"></a> [plan](#input\_plan)| The pricing plan of the Event Notifications instance. Possible values are `Lite` or `Standard`.|`string`|`"standard"`| no |
111
+
| <aname="input_region"></a> [region](#input\_region)| The IBM Cloud region where the Event Notifications instance is created. Possible values are `jp-osa` (Osaka), `au-syd` (Sydney), `jp-tok` (Tokyo), `eu-de` (Frankfurt), `eu-gb` (London), `eu-es` (Madrid), `eu-fr2` (BNPP), `us-south` (Dallas), `ca-tor` (Toronto), or `br-sao` (Sao Paulo).|`string`|`"us-south"`| no |
112
112
| <aname="input_resource_group_id"></a> [resource\_group\_id](#input\_resource\_group\_id)| The ID of the resource group where the Event Notifications instance is created. |`string`| n/a | yes |
113
-
| <aname="input_root_key_id"></a> [root\_key\_id](#input\_root\_key\_id)| The key ID of a root key, existing in the KMS instance passed in `var.existing_kms_instance_crn`, which will be used to encrypt the data encryption keys which are then used to encrypt the data. Required only if `var.kms_encryption_enabled` is set to `true`. |`string`|`null`| no |
114
-
| <aname="input_service_credential_names"></a> [service\_credential\_names](#input\_service\_credential\_names)| The mapping of names and roles for service credentials that you want to create for the Event Notifications instance. |`map(string)`|`{}`| no |
115
-
| <aname="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints)| Specify whether you want to enable public, private, or both public and private service endpoints. Possible values: `public`, `private`, `public-and-private`. |`string`|`"private"`| no |
116
-
| <aname="input_skip_en_cos_auth_policy"></a> [skip\_en\_cos\_auth\_policy](#input\_skip\_en\_cos\_auth\_policy)| Set to `true` to skip the creation of an IAM authorization policy that permits the Event Notifications instance `Object Writer` and `Reader` access to the given Object Storage bucket. Ignored if `cos_integration_enabled` is set to `false`. |`bool`|`false`| no |
117
-
| <aname="input_skip_en_kms_auth_policy"></a> [skip\_en\_kms\_auth\_policy](#input\_skip\_en\_kms\_auth\_policy)| Set to `true` to skip the creation of an IAM authorization policy that permits the Event Notifications instance to read the encryption key from the KMS instance. If set to `false`, a value must be passed for the KMS instance and key using inputs `existing_kms_instance_crn` and `root_key_id`. In addition, no policy is created if `kms_encryption_enabled` is set to `false`. |`bool`|`false`| no |
113
+
| <aname="input_root_key_id"></a> [root\_key\_id](#input\_root\_key\_id)| The key ID of a root key, existing in the key management service instance passed in `var.existing_kms_instance_crn`, which is used to encrypt the data encryption keys which are then used to encrypt the data. Required only if `var.kms_encryption_enabled` is set to `true`. |`string`|`null`| no |
114
+
| <aname="input_service_credential_names"></a> [service\_credential\_names](#input\_service\_credential\_names)| The mapping of names and roles for service credentials to create for the Event Notifications instance. |`map(string)`|`{}`| no |
115
+
| <aname="input_service_endpoints"></a> [service\_endpoints](#input\_service\_endpoints)| Specify whether you want to enable public, private, or both public and private service endpoints. Possible values are `public`, `private`, or`public-and-private`. |`string`|`"private"`| no |
116
+
| <aname="input_skip_en_cos_auth_policy"></a> [skip\_en\_cos\_auth\_policy](#input\_skip\_en\_cos\_auth\_policy)| Set to `true` to skip creating an IAM authorization policy that permits the Event Notifications instance `Object Writer` and `Reader` access to the given Object Storage bucket. Ignored if `cos_integration_enabled` is set to `false`. |`bool`|`false`| no |
117
+
| <aname="input_skip_en_kms_auth_policy"></a> [skip\_en\_kms\_auth\_policy](#input\_skip\_en\_kms\_auth\_policy)| Set to `true` to skip the creation of an IAM authorization policy that permits the Event Notifications instance to read the encryption key from the key management service instance. If set to `false`, a value must be passed for the key management service instance and key using inputs `existing_kms_instance_crn` and `root_key_id`. In addition, no policy is created if `kms_encryption_enabled` is set to `false`. |`bool`|`false`| no |
118
118
| <aname="input_tags"></a> [tags](#input\_tags)| The list of tags to add to the Event Notifications instance. |`list(string)`|`[]`| no |
0 commit comments