1. Packages
  2. Google Cloud Native
  3. API Docs
  4. securitycenter
  5. securitycenter/v1
  6. getOrganizationSecurityHealthAnalyticsSettingCustomModule

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.securitycenter/v1.getOrganizationSecurityHealthAnalyticsSettingCustomModule

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Retrieves a SecurityHealthAnalyticsCustomModule.

Using getOrganizationSecurityHealthAnalyticsSettingCustomModule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOrganizationSecurityHealthAnalyticsSettingCustomModule(args: GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs, opts?: InvokeOptions): Promise<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult>
function getOrganizationSecurityHealthAnalyticsSettingCustomModuleOutput(args: GetOrganizationSecurityHealthAnalyticsSettingCustomModuleOutputArgs, opts?: InvokeOptions): Output<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult>
Copy
def get_organization_security_health_analytics_setting_custom_module(custom_module_id: Optional[str] = None,
                                                                     organization_id: Optional[str] = None,
                                                                     opts: Optional[InvokeOptions] = None) -> GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult
def get_organization_security_health_analytics_setting_custom_module_output(custom_module_id: Optional[pulumi.Input[str]] = None,
                                                                     organization_id: Optional[pulumi.Input[str]] = None,
                                                                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult]
Copy
func LookupOrganizationSecurityHealthAnalyticsSettingCustomModule(ctx *Context, args *LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs, opts ...InvokeOption) (*LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleResult, error)
func LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleOutput(ctx *Context, args *LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleOutputArgs, opts ...InvokeOption) LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleResultOutput
Copy

> Note: This function is named LookupOrganizationSecurityHealthAnalyticsSettingCustomModule in the Go SDK.

public static class GetOrganizationSecurityHealthAnalyticsSettingCustomModule 
{
    public static Task<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> InvokeAsync(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> Invoke(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> getOrganizationSecurityHealthAnalyticsSettingCustomModule(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions options)
public static Output<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> getOrganizationSecurityHealthAnalyticsSettingCustomModule(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:securitycenter/v1:getOrganizationSecurityHealthAnalyticsSettingCustomModule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CustomModuleId This property is required. string
OrganizationId This property is required. string
CustomModuleId This property is required. string
OrganizationId This property is required. string
customModuleId This property is required. String
organizationId This property is required. String
customModuleId This property is required. string
organizationId This property is required. string
custom_module_id This property is required. str
organization_id This property is required. str
customModuleId This property is required. String
organizationId This property is required. String

getOrganizationSecurityHealthAnalyticsSettingCustomModule Result

The following output properties are available:

AncestorModule string
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
CustomConfig Pulumi.GoogleNative.Securitycenter.V1.Outputs.GoogleCloudSecuritycenterV1CustomConfigResponse
The user specified custom configuration for the module.
DisplayName string
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 string
The enablement state of the custom module.
LastEditor string
The editor that last updated the custom module.
Name string
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
UpdateTime string
The time at which the custom module was last updated.
AncestorModule string
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
CustomConfig GoogleCloudSecuritycenterV1CustomConfigResponse
The user specified custom configuration for the module.
DisplayName string
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 string
The enablement state of the custom module.
LastEditor string
The editor that last updated the custom module.
Name string
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
UpdateTime string
The time at which the custom module was last updated.
ancestorModule String
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
customConfig GoogleCloudSecuritycenterV1CustomConfigResponse
The user specified custom configuration for the module.
displayName String
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 String
The enablement state of the custom module.
lastEditor String
The editor that last updated the custom module.
name String
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
updateTime String
The time at which the custom module was last updated.
ancestorModule string
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
customConfig GoogleCloudSecuritycenterV1CustomConfigResponse
The user specified custom configuration for the module.
displayName string
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 string
The enablement state of the custom module.
lastEditor string
The editor that last updated the custom module.
name string
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
updateTime string
The time at which the custom module was last updated.
ancestor_module str
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
custom_config GoogleCloudSecuritycenterV1CustomConfigResponse
The user specified custom configuration for the module.
display_name str
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 str
The enablement state of the custom module.
last_editor str
The editor that last updated the custom module.
name str
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
update_time str
The time at which the custom module was last updated.
ancestorModule String
If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, ancestor_module specifies the organization or folder from which the custom module is inherited.
customConfig Property Map
The user specified custom configuration for the module.
displayName String
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 String
The enablement state of the custom module.
lastEditor String
The editor that last updated the custom module.
name String
Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.
updateTime String
The time at which the custom module was last updated.

Supporting Types

ExprResponse

Description This property is required. string
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
Expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
Location This property is required. string
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Title This property is required. string
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Description This property is required. string
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
Expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
Location This property is required. string
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Title This property is required. string
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
description This property is required. String
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression This property is required. String
Textual representation of an expression in Common Expression Language syntax.
location This property is required. String
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title This property is required. String
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
description This property is required. string
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression This property is required. string
Textual representation of an expression in Common Expression Language syntax.
location This property is required. string
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title This property is required. string
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
description This property is required. str
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression This property is required. str
Textual representation of an expression in Common Expression Language syntax.
location This property is required. str
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title This property is required. str
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
description This property is required. String
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression This property is required. String
Textual representation of an expression in Common Expression Language syntax.
location This property is required. String
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title This property is required. String
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

GoogleCloudSecuritycenterV1CustomConfigResponse

CustomOutput This property is required. Pulumi.GoogleNative.Securitycenter.V1.Inputs.GoogleCloudSecuritycenterV1CustomOutputSpecResponse
Custom output properties.
Description This property is required. string
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
Predicate This property is required. Pulumi.GoogleNative.Securitycenter.V1.Inputs.ExprResponse
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
Recommendation This property is required. string
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
ResourceSelector This property is required. Pulumi.GoogleNative.Securitycenter.V1.Inputs.GoogleCloudSecuritycenterV1ResourceSelectorResponse
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
Severity This property is required. string
The severity to assign to findings generated by the module.
CustomOutput This property is required. GoogleCloudSecuritycenterV1CustomOutputSpecResponse
Custom output properties.
Description This property is required. string
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
Predicate This property is required. ExprResponse
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
Recommendation This property is required. string
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
ResourceSelector This property is required. GoogleCloudSecuritycenterV1ResourceSelectorResponse
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
Severity This property is required. string
The severity to assign to findings generated by the module.
customOutput This property is required. GoogleCloudSecuritycenterV1CustomOutputSpecResponse
Custom output properties.
description This property is required. String
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
predicate This property is required. ExprResponse
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
recommendation This property is required. String
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
resourceSelector This property is required. GoogleCloudSecuritycenterV1ResourceSelectorResponse
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
severity This property is required. String
The severity to assign to findings generated by the module.
customOutput This property is required. GoogleCloudSecuritycenterV1CustomOutputSpecResponse
Custom output properties.
description This property is required. string
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
predicate This property is required. ExprResponse
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
recommendation This property is required. string
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
resourceSelector This property is required. GoogleCloudSecuritycenterV1ResourceSelectorResponse
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
severity This property is required. string
The severity to assign to findings generated by the module.
custom_output This property is required. GoogleCloudSecuritycenterV1CustomOutputSpecResponse
Custom output properties.
description This property is required. str
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
predicate This property is required. ExprResponse
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
recommendation This property is required. str
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
resource_selector This property is required. GoogleCloudSecuritycenterV1ResourceSelectorResponse
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
severity This property is required. str
The severity to assign to findings generated by the module.
customOutput This property is required. Property Map
Custom output properties.
description This property is required. String
Text that describes the vulnerability or misconfiguration that the custom module detects. This explanation is returned with each finding instance to help investigators understand the detected issue. The text must be enclosed in quotation marks.
predicate This property is required. Property Map
The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
recommendation This property is required. String
An explanation of the recommended steps that security teams can take to resolve the detected issue. This explanation is returned with each finding generated by this module in the nextSteps property of the finding JSON.
resourceSelector This property is required. Property Map
The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
severity This property is required. String
The severity to assign to findings generated by the module.

GoogleCloudSecuritycenterV1CustomOutputSpecResponse

Properties This property is required. List<Pulumi.GoogleNative.Securitycenter.V1.Inputs.GoogleCloudSecuritycenterV1PropertyResponse>
A list of custom output properties to add to the finding.
Properties This property is required. []GoogleCloudSecuritycenterV1PropertyResponse
A list of custom output properties to add to the finding.
properties This property is required. List<GoogleCloudSecuritycenterV1PropertyResponse>
A list of custom output properties to add to the finding.
properties This property is required. GoogleCloudSecuritycenterV1PropertyResponse[]
A list of custom output properties to add to the finding.
properties This property is required. Sequence[GoogleCloudSecuritycenterV1PropertyResponse]
A list of custom output properties to add to the finding.
properties This property is required. List<Property Map>
A list of custom output properties to add to the finding.

GoogleCloudSecuritycenterV1PropertyResponse

Name This property is required. string
Name of the property for the custom output.
ValueExpression This property is required. Pulumi.GoogleNative.Securitycenter.V1.Inputs.ExprResponse
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
Name This property is required. string
Name of the property for the custom output.
ValueExpression This property is required. ExprResponse
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
name This property is required. String
Name of the property for the custom output.
valueExpression This property is required. ExprResponse
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
name This property is required. string
Name of the property for the custom output.
valueExpression This property is required. ExprResponse
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
name This property is required. str
Name of the property for the custom output.
value_expression This property is required. ExprResponse
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.
name This property is required. String
Name of the property for the custom output.
valueExpression This property is required. Property Map
The CEL expression for the custom output. A resource property can be specified to return the value of the property or a text string enclosed in quotation marks.

GoogleCloudSecuritycenterV1ResourceSelectorResponse

ResourceTypes This property is required. List<string>
The resource types to run the detector on.
ResourceTypes This property is required. []string
The resource types to run the detector on.
resourceTypes This property is required. List<String>
The resource types to run the detector on.
resourceTypes This property is required. string[]
The resource types to run the detector on.
resource_types This property is required. Sequence[str]
The resource types to run the detector on.
resourceTypes This property is required. List<String>
The resource types to run the detector on.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi