Resource: SecurityHealthAnalyticsCustomModule
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 descendant folders and projects.
JSON representation |
---|
{ "name": string, "displayName": string, "enablementState": enum ( |
Fields | |
---|---|
name |
Identifier. The full resource name of the custom module, in one of the following formats:
|
displayName |
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. |
enablementState |
Optional. The enablement state of the custom module. |
updateTime |
Output only. The time at which the custom module was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastEditor |
Output only. The editor that last updated the custom module. |
ancestorModule |
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. |
customConfig |
Optional. The user-specified custom configuration for the module. |
Methods |
|
---|---|
|
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given organization, folder, or project, and also creates inherited SecurityHealthAnalyticsCustomModule resources for all folders and projects that are descendants of the given parent. |
|
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the resource hierarchy. |
|
Retrieves a SecurityHealthAnalyticsCustomModule . |
|
Returns a list of all SecurityHealthAnalyticsCustomModule resources for the given parent. |
|
Returns a list of all resident SecurityHealthAnalyticsCustomModule resources under the given organization, folder, or project and all of its descendants. |
|
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. |
|
Simulates the result of using a SecurityHealthAnalyticsCustomModule to check a resource. |