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>
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]
func LookupOrganizationSecurityHealthAnalyticsSettingCustomModule(ctx *Context, args *LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs, opts ...InvokeOption) (*LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleResult, error)
func LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleOutput(ctx *Context, args *LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleOutputArgs, opts ...InvokeOption) LookupOrganizationSecurityHealthAnalyticsSettingCustomModuleResultOutput
> 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)
}
public static CompletableFuture<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> getOrganizationSecurityHealthAnalyticsSettingCustomModule(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions options)
public static Output<GetOrganizationSecurityHealthAnalyticsSettingCustomModuleResult> getOrganizationSecurityHealthAnalyticsSettingCustomModule(GetOrganizationSecurityHealthAnalyticsSettingCustomModuleArgs args, InvokeOptions options)
fn::invoke:
function: google-native:securitycenter/v1:getOrganizationSecurityHealthAnalyticsSettingCustomModule
arguments:
# arguments dictionary
The following arguments are supported:
- Custom
Module Id This property is required. string - Organization
Id This property is required. string
- Custom
Module Id This property is required. string - Organization
Id This property is required. string
- custom
Module Id This property is required. String - organization
Id This property is required. String
- custom
Module Id This property is required. string - organization
Id This property is required. string
- custom_
module_ id This property is required. str - organization_
id This property is required. str
- custom
Module Id This property is required. String - organization
Id This property is required. String
getOrganizationSecurityHealthAnalyticsSettingCustomModule Result
The following output properties are available:
- Ancestor
Module 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. - Custom
Config Pulumi.Google Native. Securitycenter. V1. Outputs. Google Cloud Securitycenter V1Custom Config Response - The user specified custom configuration for the module.
- Display
Name 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.
- Enablement
State string - The enablement state of the custom module.
- Last
Editor 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.
- Update
Time string - The time at which the custom module was last updated.
- Ancestor
Module 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. - Custom
Config GoogleCloud Securitycenter V1Custom Config Response - The user specified custom configuration for the module.
- Display
Name 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.
- Enablement
State string - The enablement state of the custom module.
- Last
Editor 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.
- Update
Time string - The time at which the custom module was last updated.
- ancestor
Module 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. - custom
Config GoogleCloud Securitycenter V1Custom Config Response - The user specified custom configuration for the module.
- display
Name 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.
- enablement
State String - The enablement state of the custom module.
- last
Editor 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.
- update
Time String - The time at which the custom module was last updated.
- ancestor
Module 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. - custom
Config GoogleCloud Securitycenter V1Custom Config Response - The user specified custom configuration for the module.
- display
Name 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.
- enablement
State string - The enablement state of the custom module.
- last
Editor 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.
- update
Time 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 GoogleCloud Securitycenter V1Custom Config Response - 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.
- ancestor
Module 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. - custom
Config Property Map - The user specified custom configuration for the module.
- display
Name 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.
- enablement
State String - The enablement state of the custom module.
- last
Editor 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.
- update
Time 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
- Custom
Output This property is required. Pulumi.Google Native. Securitycenter. V1. Inputs. Google Cloud Securitycenter V1Custom Output Spec Response - 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.Google Native. Securitycenter. V1. Inputs. Expr Response - 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. - Resource
Selector This property is required. Pulumi.Google Native. Securitycenter. V1. Inputs. Google Cloud Securitycenter V1Resource Selector Response - 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. GoogleCloud Securitycenter V1Custom Output Spec Response - 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. - Resource
Selector This property is required. GoogleCloud Securitycenter V1Resource Selector Response - 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. GoogleCloud Securitycenter V1Custom Output Spec Response - 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. - resource
Selector This property is required. GoogleCloud Securitycenter V1Resource Selector Response - 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. GoogleCloud Securitycenter V1Custom Output Spec Response - 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. - resource
Selector This property is required. GoogleCloud Securitycenter V1Resource Selector Response - 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. GoogleCloud Securitycenter V1Custom Output Spec Response - 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. GoogleCloud Securitycenter V1Resource Selector Response - 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.
- custom
Output 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. - resource
Selector 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.Google Native. Securitycenter. V1. Inputs. Google Cloud Securitycenter V1Property Response> - A list of custom output properties to add to the finding.
- Properties
This property is required. []GoogleCloud Securitycenter V1Property Response - A list of custom output properties to add to the finding.
- properties
This property is required. List<GoogleCloud Securitycenter V1Property Response> - A list of custom output properties to add to the finding.
- properties
This property is required. GoogleCloud Securitycenter V1Property Response[] - A list of custom output properties to add to the finding.
- properties
This property is required. Sequence[GoogleCloud Securitycenter V1Property Response] - 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.
- Value
Expression This property is required. Pulumi.Google Native. Securitycenter. V1. Inputs. Expr Response - 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.
- 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.
- 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.
- 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. 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.
- value
Expression 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
- Resource
Types This property is required. List<string> - The resource types to run the detector on.
- Resource
Types This property is required. []string - The resource types to run the detector on.
- resource
Types This property is required. List<String> - The resource types to run the detector on.
- resource
Types 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.
- resource
Types 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