Class: Aws::Macie2::Types::CreateCustomDataIdentifierRequest

Inherits:

Struct

• Object
• Struct
• Aws::Macie2::Types::CreateCustomDataIdentifierRequest

Defined in:

gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb

Overview

Specifies the detection criteria and other settings for a custom data identifier. You can't change a custom data identifier after you create it. This helps to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A suitable default value is auto-generated. You should normally not need to pass this option.

• #description ⇒ String
• #ignore_words ⇒ Array<String>
• #keywords ⇒ Array<String>
• #maximum_match_distance ⇒ Integer
• #name ⇒ String
• #regex ⇒ String
• #severity_levels ⇒ Array<Types::SeverityLevel>

  The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria.

• #tags ⇒ Hash<String,String>

  A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

Instance Attribute Details

#client_token ⇒ String

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Returns:

• (String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ignore_words ⇒ Array<String>

Returns:

• (Array<String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#keywords ⇒ Array<String>

Returns:

• (Array<String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_match_distance ⇒ Integer

Returns:

• (Integer)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Returns:

• (String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#regex ⇒ String

Returns:

• (String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#severity_levels ⇒ Array<Types::SeverityLevel>

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.

Returns:

• (Array<Types::SeverityLevel>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1297

class CreateCustomDataIdentifierRequest < Struct.new(
  :client_token,
  :description,
  :ignore_words,
  :keywords,
  :maximum_match_distance,
  :name,
  :regex,
  :severity_levels,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end