| access_tags |
Add existing access management tags to the Cloud Logs instance to manage access. Before you can attach your access management tags you need to create them first. Learn more. |
list(string) |
[] |
no |
| cbr_rules |
The context-based restrictions rule to create. Only one rule is allowed. |
list(object({
description = string
account_id = string
rule_contexts = list(object({
attributes = optional(list(object({
name = string
value = string
}))) }))
enforcement_mode = string
operations = optional(list(object({
api_types = list(object({
api_type_id = string
}))
})))
})) |
[] |
no |
| data_storage |
A logs data bucket and a metrics bucket in IBM Cloud Object Storage to store your IBM Cloud Logs data for long term storage, search, analysis and alerting. |
object({
logs_data = optional(object({
enabled = optional(bool, false)
bucket_crn = optional(string)
bucket_endpoint = optional(string)
skip_cos_auth_policy = optional(bool, false)
}), {})
metrics_data = optional(object({
enabled = optional(bool, false)
bucket_crn = optional(string)
bucket_endpoint = optional(string)
skip_cos_auth_policy = optional(bool, false)
}), {})
}
) |
{
"logs_data": null,
"metrics_data": null
} |
no |
| existing_event_notifications_instances |
List of Event Notifications instance details for routing critical events that occur in your IBM Cloud Logs. |
list(object({
crn = string
integration_name = optional(string)
integration_endpoint_type = optional(string, "private")
skip_iam_auth_policy = optional(bool, false)
cloud_logs_endpoint_type = optional(string, "public")
})) |
[] |
no |
| instance_name |
The name of the IBM Cloud Logs instance to create. Defaults to 'cloud-logs-' |
string |
null |
no |
| logs_routing_tenant_regions |
Pass a list of regions to create a tenant for that is targeted to the IBM Cloud Logs instance created by this module. To manage platform logs that are generated by IBM Cloud® services in a region of IBM Cloud, you must create a tenant in each region that you operate. Leave the list empty if you don't want to create any tenants. NOTE: You can only have 1 tenant per region in an account. |
list(any) |
[] |
no |
| parsing_rules |
Configuration of IBM Cloud Logs parsing rule groups. |
list(object({
name = string
description = optional(string, null)
enabled = optional(bool, true)
order = optional(number, null)
rule_matchers = optional(list(object({
application_name = optional(object({
value = string
}), null)
subsystem_name = optional(object({
value = string
}), null)
severity = optional(object({
value = string
}), null)
})), [])
rule_subgroups = list(object({
enabled = optional(bool, true)
order = optional(number, null)
rules = list(object({
name = string
description = optional(string, null)
source_field = string
enabled = optional(bool, true)
order = optional(number, null)
parameters = object({
parse_parameters = optional(object({
destination_field = string
rule = string
}), null)
block_parameters = optional(object({
keep_blocked_logs = bool
rule = string
}), null)
extract_parameters = optional(object({
rule = string
}), null)
json_extract_parameters = optional(object({
destination_field = string
}), null)
replace_parameters = optional(object({
destination_field = string
replace_new_val = string
rule = string
}), null)
allow_parameters = optional(object({
keep_blocked_logs = bool
rule = string
}), null)
extract_timestamp_parameters = optional(object({
format = string
standard = string
}), null)
remove_fields_parameters = optional(object({
fields = list(string)
}), null)
json_stringify_parameters = optional(object({
destination_field = optional(string, null)
delete_source = optional(bool, null)
}), null)
json_parse_parameters = optional(object({
destination_field = optional(string, null)
delete_source = optional(bool, null)
override_dest = optional(bool, null)
}), null)
})
}))
}))
})) |
[] |
no |
| parsing_rules_endpoint_type |
The endpoint type to use to communicate with the IBM Cloud Logs instance when creating parsing rules. Allowed values: public, private. |
string |
"public" |
no |
| plan |
The IBM Cloud Logs plan to provision. Available plans: lite,standard, standard-plus-metrics. Currently,lite and standard-plus-metrics are available for allowlisted accounts only. |
string |
"standard" |
no |
| policies |
Configuration of IBM Cloud Logs policies. |
list(object({
logs_policy_name = string
logs_policy_description = optional(string, null)
logs_policy_priority = string
application_rule = optional(list(object({
name = string
rule_type_id = string
})))
subsystem_rule = optional(list(object({
name = string
rule_type_id = string
})))
log_rules = optional(list(object({
severities = list(string)
})))
archive_retention = optional(list(object({
id = string
})))
})) |
[] |
no |
| region |
The IBM Cloud region where IBM Cloud logs instance will be created. |
string |
"us-south" |
no |
| resource_group_id |
The id of the IBM Cloud resource group where the instance will be created. |
string |
null |
no |
| resource_tags |
Add user resource tags to the Cloud Logs instance to organize, track, and manage costs. Learn more. |
list(string) |
[] |
no |
| retention_period |
The number of days IBM Cloud Logs will retain the logs data in Priority insights. Allowed values: 7, 14, 30, 60, 90. |
number |
7 |
no |
| service_endpoints |
The type of the service endpoint that will be set for the IBM Cloud Logs instance. Allowed values: public-and-private. |
string |
"public-and-private" |
no |
| skip_logs_routing_auth_policy |
Whether to create an IAM authorization policy that permits the Logs Routing server 'Sender' access to the IBM Cloud Logs instance created by this module. |
bool |
false |
no |
-brightgreen){kind=icon}
