Package software.amazon.awssdk.services.macie2.model

Interface CreateCustomDataIdentifierRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>, Macie2Request.Builder, SdkBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCustomDataIdentifierRequest
public static interface CreateCustomDataIdentifierRequest.Builder extends Macie2Request.Builder, SdkPojo, CopyableBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>

  • Method Details

    • clientToken

      CreateCustomDataIdentifierRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateCustomDataIdentifierRequest.Builder description(String description)

      A custom description of the custom data identifier. The description can contain as many as 512 characters.

      We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.

      Parameters:
      description - A custom description of the custom data identifier. The description can contain as many as 512 characters.

      We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ignoreWords

      CreateCustomDataIdentifierRequest.Builder ignoreWords(Collection<String> ignoreWords)

      An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

      Parameters:
      ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ignoreWords

      CreateCustomDataIdentifierRequest.Builder ignoreWords(String... ignoreWords)

      An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

      Parameters:
      ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keywords

      CreateCustomDataIdentifierRequest.Builder keywords(Collection<String> keywords)

      An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

      Parameters:
      keywords - An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keywords

      CreateCustomDataIdentifierRequest.Builder keywords(String... keywords)

      An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

      Parameters:
      keywords - An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumMatchDistance

      CreateCustomDataIdentifierRequest.Builder maximumMatchDistance(Integer maximumMatchDistance)

      The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

      Parameters:
      maximumMatchDistance - The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateCustomDataIdentifierRequest.Builder name(String name)

      A custom name for the custom data identifier. The name can contain as many as 128 characters.

      We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.

      Parameters:
      name - A custom name for the custom data identifier. The name can contain as many as 128 characters.

      We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regex

      CreateCustomDataIdentifierRequest.Builder regex(String regex)

      The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

      Parameters:
      regex - The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severityLevels

      CreateCustomDataIdentifierRequest.Builder severityLevels(Collection<SeverityLevel> severityLevels)

      The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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 assigns the MEDIUM severity to those findings.

      Parameters:
      severityLevels - The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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 assigns the MEDIUM severity to those findings.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severityLevels

      CreateCustomDataIdentifierRequest.Builder severityLevels(SeverityLevel... severityLevels)

      The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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 assigns the MEDIUM severity to those findings.

      Parameters:
      severityLevels - The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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 assigns the MEDIUM severity to those findings.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severityLevels

      CreateCustomDataIdentifierRequest.Builder severityLevels(Consumer<SeverityLevel.Builder>... severityLevels)

      The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match 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 assigns the MEDIUM severity to those findings.

      This is a convenience method that creates an instance of the SeverityLevel.Builder avoiding the need to create one manually via SeverityLevel.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to severityLevels(List<SeverityLevel>).

      Parameters:
      severityLevels - a consumer that will call methods on SeverityLevel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateCustomDataIdentifierRequest.Builder tags(Map<String,String> tags)

      A map of key-value pairs that specifies the tags to associate with the custom data identifier.

      A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      Parameters:
      tags - A map of key-value pairs that specifies the tags to associate with the custom data identifier.

      A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateCustomDataIdentifierRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateCustomDataIdentifierRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.