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

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
pulumi/pulumi-google-native

google-native.securitycenter/v1.getProjectSecurityHealthAnalyticsSettingCustomModule

Explore with Pulumi AI

google-native logo

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
pulumi/pulumi-google-native

    Retrieves a SecurityHealthAnalyticsCustomModule.

    Using getProjectSecurityHealthAnalyticsSettingCustomModule

    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 getProjectSecurityHealthAnalyticsSettingCustomModule(args: GetProjectSecurityHealthAnalyticsSettingCustomModuleArgs, opts?: InvokeOptions): Promise<GetProjectSecurityHealthAnalyticsSettingCustomModuleResult>
function getProjectSecurityHealthAnalyticsSettingCustomModuleOutput(args: GetProjectSecurityHealthAnalyticsSettingCustomModuleOutputArgs, opts?: InvokeOptions): Output<GetProjectSecurityHealthAnalyticsSettingCustomModuleResult>
    def get_project_security_health_analytics_setting_custom_module(custom_module_id: Optional[str] = None,
                                                                project: Optional[str] = None,
                                                                opts: Optional[InvokeOptions] = None) -> GetProjectSecurityHealthAnalyticsSettingCustomModuleResult
def get_project_security_health_analytics_setting_custom_module_output(custom_module_id: Optional[pulumi.Input[str]] = None,
                                                                project: Optional[pulumi.Input[str]] = None,
                                                                opts: Optional[InvokeOptions] = None) -> Output[GetProjectSecurityHealthAnalyticsSettingCustomModuleResult]
    func LookupProjectSecurityHealthAnalyticsSettingCustomModule(ctx *Context, args *LookupProjectSecurityHealthAnalyticsSettingCustomModuleArgs, opts ...InvokeOption) (*LookupProjectSecurityHealthAnalyticsSettingCustomModuleResult, error)
func LookupProjectSecurityHealthAnalyticsSettingCustomModuleOutput(ctx *Context, args *LookupProjectSecurityHealthAnalyticsSettingCustomModuleOutputArgs, opts ...InvokeOption) LookupProjectSecurityHealthAnalyticsSettingCustomModuleResultOutput

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

    public static class GetProjectSecurityHealthAnalyticsSettingCustomModule 
{
    public static Task<GetProjectSecurityHealthAnalyticsSettingCustomModuleResult> InvokeAsync(GetProjectSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectSecurityHealthAnalyticsSettingCustomModuleResult> Invoke(GetProjectSecurityHealthAnalyticsSettingCustomModuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProjectSecurityHealthAnalyticsSettingCustomModuleResult> getProjectSecurityHealthAnalyticsSettingCustomModule(GetProjectSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:securitycenter/v1:getProjectSecurityHealthAnalyticsSettingCustomModule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CustomModuleId string
    Project string
    CustomModuleId string
    Project string
    customModuleId String
    project String
    customModuleId string
    project string
    customModuleId String
    project String

    getProjectSecurityHealthAnalyticsSettingCustomModule 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 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 string
    Textual representation of an expression in Common Expression Language syntax.
    Location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    Title 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 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 string
    Textual representation of an expression in Common Expression Language syntax.
    Location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    Title 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 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 String
    Textual representation of an expression in Common Expression Language syntax.
    location String
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title 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 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 string
    Textual representation of an expression in Common Expression Language syntax.
    location string
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title 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 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 str
    Textual representation of an expression in Common Expression Language syntax.
    location str
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title 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 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 String
    Textual representation of an expression in Common Expression Language syntax.
    location String
    Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    title 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 Pulumi.GoogleNative.Securitycenter.V1.Inputs.GoogleCloudSecuritycenterV1CustomOutputSpecResponse
    Custom output properties.
    Description 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 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 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 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 string
    The severity to assign to findings generated by the module.
    CustomOutput GoogleCloudSecuritycenterV1CustomOutputSpecResponse
    Custom output properties.
    Description 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 ExprResponse
    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
    Recommendation 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 GoogleCloudSecuritycenterV1ResourceSelectorResponse
    The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
    Severity string
    The severity to assign to findings generated by the module.
    customOutput GoogleCloudSecuritycenterV1CustomOutputSpecResponse
    Custom output properties.
    description 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 ExprResponse
    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
    recommendation 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 GoogleCloudSecuritycenterV1ResourceSelectorResponse
    The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
    severity String
    The severity to assign to findings generated by the module.
    customOutput GoogleCloudSecuritycenterV1CustomOutputSpecResponse
    Custom output properties.
    description 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 ExprResponse
    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
    recommendation 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 GoogleCloudSecuritycenterV1ResourceSelectorResponse
    The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
    severity string
    The severity to assign to findings generated by the module.
    custom_output GoogleCloudSecuritycenterV1CustomOutputSpecResponse
    Custom output properties.
    description 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 ExprResponse
    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
    recommendation 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 GoogleCloudSecuritycenterV1ResourceSelectorResponse
    The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
    severity str
    The severity to assign to findings generated by the module.
    customOutput Property Map
    Custom output properties.
    description 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 Property Map
    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.
    recommendation 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 Property Map
    The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.
    severity String
    The severity to assign to findings generated by the module.

    GoogleCloudSecuritycenterV1CustomOutputSpecResponse

    Properties []GoogleCloudSecuritycenterV1PropertyResponse
    A list of custom output properties to add to the finding.
    properties List<GoogleCloudSecuritycenterV1PropertyResponse>
    A list of custom output properties to add to the finding.
    properties GoogleCloudSecuritycenterV1PropertyResponse[]
    A list of custom output properties to add to the finding.
    properties Sequence[GoogleCloudSecuritycenterV1PropertyResponse]
    A list of custom output properties to add to the finding.
    properties List<Property Map>
    A list of custom output properties to add to the finding.

    GoogleCloudSecuritycenterV1PropertyResponse

    Name string
    Name of the property for the custom output.
    ValueExpression 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 string
    Name of the property for the custom output.
    ValueExpression 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 String
    Name of the property for the custom output.
    valueExpression 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 string
    Name of the property for the custom output.
    valueExpression 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 str
    Name of the property for the custom output.
    value_expression 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 String
    Name of the property for the custom output.
    valueExpression 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 List<string>
    The resource types to run the detector on.
    ResourceTypes []string
    The resource types to run the detector on.
    resourceTypes List<String>
    The resource types to run the detector on.
    resourceTypes string[]
    The resource types to run the detector on.
    resource_types Sequence[str]
    The resource types to run the detector on.
    resourceTypes 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-native logo

    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
    pulumi/pulumi-google-native