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.
Inherits
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#custom_config
def custom_config() -> ::Google::Cloud::SecurityCenter::V1::CustomConfig
- (::Google::Cloud::SecurityCenter::V1::CustomConfig) — Output only. The user-specified configuration for the module.
#display_name
def display_name() -> ::String
- (::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.
#enablement_state
def enablement_state() -> ::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.
#name
def name() -> ::String
- (::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}"