Reference documentation and code samples for the Cloud Security Command Center V1 API class Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule.
An EffectiveSecurityHealthAnalyticsCustomModule is the representation of
a Security Health Analytics custom module at a specified level of the
resource hierarchy: organization, folder, or project. If a custom module is
inherited from a parent organization or folder, the value of the
enablementState property in EffectiveSecurityHealthAnalyticsCustomModule is
set to the value that is effective in the parent, instead of INHERITED.
For example, if the module is enabled in a parent organization or folder, the
effective enablement_state for the module in all child folders or projects is
also enabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only.
(::String) — Output only. The display name for the custom module. The name must be
between 1 and 128 characters, start with a lowercase letter, and contain
alphanumeric characters or underscores only.
(::String) — Output only. The resource name of the custom module.
Its format is
"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}",
or
"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Security Command Center V1 API - Class Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule (v1.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.5.0 (latest)](/ruby/docs/reference/google-cloud-security_center-v1/latest/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.4.1](/ruby/docs/reference/google-cloud-security_center-v1/1.4.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.3.0](/ruby/docs/reference/google-cloud-security_center-v1/1.3.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.2.0](/ruby/docs/reference/google-cloud-security_center-v1/1.2.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.1.0](/ruby/docs/reference/google-cloud-security_center-v1/1.1.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [1.0.0](/ruby/docs/reference/google-cloud-security_center-v1/1.0.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.41.0](/ruby/docs/reference/google-cloud-security_center-v1/0.41.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.40.0](/ruby/docs/reference/google-cloud-security_center-v1/0.40.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.39.0](/ruby/docs/reference/google-cloud-security_center-v1/0.39.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.38.0](/ruby/docs/reference/google-cloud-security_center-v1/0.38.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.37.0](/ruby/docs/reference/google-cloud-security_center-v1/0.37.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.36.0](/ruby/docs/reference/google-cloud-security_center-v1/0.36.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.35.0](/ruby/docs/reference/google-cloud-security_center-v1/0.35.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.34.2](/ruby/docs/reference/google-cloud-security_center-v1/0.34.2/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.33.0](/ruby/docs/reference/google-cloud-security_center-v1/0.33.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.32.0](/ruby/docs/reference/google-cloud-security_center-v1/0.32.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.31.1](/ruby/docs/reference/google-cloud-security_center-v1/0.31.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.30.0](/ruby/docs/reference/google-cloud-security_center-v1/0.30.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.29.1](/ruby/docs/reference/google-cloud-security_center-v1/0.29.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.28.0](/ruby/docs/reference/google-cloud-security_center-v1/0.28.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.27.0](/ruby/docs/reference/google-cloud-security_center-v1/0.27.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.26.0](/ruby/docs/reference/google-cloud-security_center-v1/0.26.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.25.1](/ruby/docs/reference/google-cloud-security_center-v1/0.25.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.24.0](/ruby/docs/reference/google-cloud-security_center-v1/0.24.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.23.0](/ruby/docs/reference/google-cloud-security_center-v1/0.23.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.22.0](/ruby/docs/reference/google-cloud-security_center-v1/0.22.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.21.0](/ruby/docs/reference/google-cloud-security_center-v1/0.21.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.20.0](/ruby/docs/reference/google-cloud-security_center-v1/0.20.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.19.0](/ruby/docs/reference/google-cloud-security_center-v1/0.19.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.18.0](/ruby/docs/reference/google-cloud-security_center-v1/0.18.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.17.0](/ruby/docs/reference/google-cloud-security_center-v1/0.17.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.16.0](/ruby/docs/reference/google-cloud-security_center-v1/0.16.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.15.0](/ruby/docs/reference/google-cloud-security_center-v1/0.15.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.14.0](/ruby/docs/reference/google-cloud-security_center-v1/0.14.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.13.0](/ruby/docs/reference/google-cloud-security_center-v1/0.13.0/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.12.1](/ruby/docs/reference/google-cloud-security_center-v1/0.12.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule)\n- [0.11.1](/ruby/docs/reference/google-cloud-security_center-v1/0.11.1/Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule) \nReference documentation and code samples for the Cloud Security Command Center V1 API class Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule.\n\nAn EffectiveSecurityHealthAnalyticsCustomModule is the representation of\na Security Health Analytics custom module at a specified level of the\nresource hierarchy: organization, folder, or project. If a custom module is\ninherited from a parent organization or folder, the value of the\n`enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule is\nset to the value that is effective in the parent, instead of `INHERITED`.\nFor example, if the module is enabled in a parent organization or folder, the\neffective enablement_state for the module in all child folders or projects is\nalso `enabled`. EffectiveSecurityHealthAnalyticsCustomModule is read-only. \n\nInherits\n--------\n\n- [Object](./Google-Cloud-SecurityCenter-V1-Kubernetes-Object) \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #custom_config\n\n def custom_config() -\u003e ::Google::Cloud::SecurityCenter::V1::CustomConfig\n\n**Returns**\n\n- ([::Google::Cloud::SecurityCenter::V1::CustomConfig](./Google-Cloud-SecurityCenter-V1-CustomConfig)) --- Output only. The user-specified configuration for the module.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.\n\n### #enablement_state\n\n def enablement_state() -\u003e ::Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState\n\n**Returns**\n\n- ([::Google::Cloud::SecurityCenter::V1::EffectiveSecurityHealthAnalyticsCustomModule::EnablementState](./Google-Cloud-SecurityCenter-V1-EffectiveSecurityHealthAnalyticsCustomModule-EnablementState)) --- Output only. The effective state of enablement for the module at the given level of the hierarchy.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The resource name of the custom module. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\""]]
