REST Resource: folders.locations.effectiveSecurityHealthAnalyticsCustomModules

Resource: 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 enablementState for the module in all child folders or projects is also enabled. EffectiveSecurityHealthAnalyticsCustomModule is read-only.

JSON representation
{
  "name": string,
  "customConfig": {
    object (CustomConfig)
  },
  "enablementState": enum (EnablementState),
  "displayName": string
}
Fields
name

string

Output only. The resource name of the custom module. Its format is "organizations/{organization}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}", or "folders/{folder}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}", or "projects/{project}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}"

customConfig

object (CustomConfig)

Output only. The user-specified configuration for the module.

enablementState

enum (EnablementState)

Output only. The effective state of enablement for the module at the given level of the hierarchy.

displayName

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.

EnablementState

The enablement state of the module.

Enums
ENABLEMENT_STATE_UNSPECIFIED Unspecified enablement state.
ENABLED The module is enabled at the given level.
DISABLED The module is disabled at the given level.

Methods

get

Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.

list

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent.