SecurityHealthAnalyticsCustomModule(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.
Attributes | |
|---|---|
| Name | Description |
name |
str
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}", or "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}", or "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. |
display_name |
str
Optional. The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. |
enablement_state |
google.cloud.securitycentermanagement_v1.types.SecurityHealthAnalyticsCustomModule.EnablementState
Optional. The enablement state of the custom module. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the custom module was last updated. |
last_editor |
str
Output only. The editor that last updated the custom module. |
ancestor_module |
str
Output only. Specifies the organization or folder from which the custom module is inherited. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. |
custom_config |
google.cloud.securitycentermanagement_v1.types.CustomConfig
Optional. The user specified custom configuration for the module. |
Classes
EnablementState
EnablementState(value)Possible enablement states of a custom module.
Values: ENABLEMENT_STATE_UNSPECIFIED (0): Unspecified enablement state. ENABLED (1): The module is enabled at the given CRM resource. DISABLED (2): The module is disabled at the given CRM resource. INHERITED (3): State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy. Attempting to set a top level module (module with no parent) to the INHERITED state will result in an INVALID_ARGUMENT error.