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

Interface GetCustomDataIdentifierResponse.Builder

    • Method Detail

      • arn

        GetCustomDataIdentifierResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the custom data identifier.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the custom data identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        GetCustomDataIdentifierResponse.Builder createdAt​(Instant createdAt)

        The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

        Parameters:
        createdAt - The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deleted

        GetCustomDataIdentifierResponse.Builder deleted​(Boolean deleted)

        Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

        Parameters:
        deleted - Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        GetCustomDataIdentifierResponse.Builder description​(String description)

        The custom description of the custom data identifier.

        Parameters:
        description - The custom description of the custom data identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • id

        GetCustomDataIdentifierResponse.Builder id​(String id)

        The unique identifier for the custom data identifier.

        Parameters:
        id - The unique identifier for the custom data identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ignoreWords

        GetCustomDataIdentifierResponse.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. 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. Ignore words are case sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ignoreWords

        GetCustomDataIdentifierResponse.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. 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. Ignore words are case sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keywords

        GetCustomDataIdentifierResponse.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. 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. Keywords aren't case sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keywords

        GetCustomDataIdentifierResponse.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. 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. Keywords aren't case sensitive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maximumMatchDistance

        GetCustomDataIdentifierResponse.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. Otherwise, Macie excludes the result.

        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. Otherwise, Macie excludes the result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        GetCustomDataIdentifierResponse.Builder name​(String name)

        The custom name of the custom data identifier.

        Parameters:
        name - The custom name of the custom data identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regex

        GetCustomDataIdentifierResponse.Builder regex​(String regex)

        The regular expression (regex) that defines the pattern to match.

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

      • severityLevels

        GetCustomDataIdentifierResponse.Builder severityLevels​(Collection<SeverityLevel> severityLevels)

        Specifies the severity that's assigned 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. By default, Amazon 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 - Specifies the severity that's assigned 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. By default, Amazon 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

        GetCustomDataIdentifierResponse.Builder severityLevels​(SeverityLevel... severityLevels)

        Specifies the severity that's assigned 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. By default, Amazon 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 - Specifies the severity that's assigned 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. By default, Amazon 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

        GetCustomDataIdentifierResponse.Builder severityLevels​(Consumer<SeverityLevel.Builder>... severityLevels)

        Specifies the severity that's assigned 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. By default, Amazon 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).

        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:
        #severityLevels(java.util.Collection)

      • tags

        GetCustomDataIdentifierResponse.Builder tags​(Map<String,​String> tags)

        A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

        Parameters:
        tags - A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.