Class: Google::Cloud::SecurityCenter::V1::CustomConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb

Overview

Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.

Defined Under Namespace

Modules: Severity Classes: CustomOutputSpec, ResourceSelector

Instance Attribute Summary collapse

Instance Attribute Details

#custom_output ⇒ ::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec

Returns Custom output properties.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end

#description ⇒ ::String

Returns 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.

Returns:

  • (::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.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end

#predicate ⇒ ::Google::Type::Expr

Returns The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.

Returns:

  • (::Google::Type::Expr) —

    The CEL expression to evaluate to produce findings. When the expression evaluates to true against a resource, a finding is generated.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end

#recommendation ⇒ ::String

Returns 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.

Returns:

  • (::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.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end

#resource_selector ⇒ ::Google::Cloud::SecurityCenter::V1::CustomConfig::ResourceSelector

Returns The resource types that the custom module operates on. Each custom module can specify up to 5 resource types.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end

#severity ⇒ ::Google::Cloud::SecurityCenter::V1::CustomConfig::Severity

Returns The severity to assign to findings generated by the module.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/securitycenter/v1/security_health_analytics_custom_config.rb', line 52

class CustomConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A set of optional name-value pairs that define custom source properties to
  # return with each finding that is generated by the custom module. The custom
  # source properties that are defined here are included in the finding JSON
  # under `sourceProperties`.
  # @!attribute [rw] properties
  #   @return [::Array<::Google::Cloud::SecurityCenter::V1::CustomConfig::CustomOutputSpec::Property>]
  #     A list of custom output properties to add to the finding.
  class CustomOutputSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An individual name-value pair that defines a custom source property.
    # @!attribute [rw] name
    #   @return [::String]
    #     Name of the property for the custom output.
    # @!attribute [rw] value_expression
    #   @return [::Google::Type::Expr]
    #     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.
    class Property
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Resource for selecting resource type.
  # @!attribute [rw] resource_types
  #   @return [::Array<::String>]
  #     The resource types to run the detector on.
  class ResourceSelector
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the valid value options for the severity of a finding.
  module Severity
    # Unspecified severity.
    SEVERITY_UNSPECIFIED = 0

    # Critical severity.
    CRITICAL = 1

    # High severity.
    HIGH = 2

    # Medium severity.
    MEDIUM = 3

    # Low severity.
    LOW = 4
  end
end