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

Class CreateFindingsFilterRequest

    • Method Detail

      • action

        public final FindingsFilterAction action()

        The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

        If the service returns an enum value that is not available in the current SDK version, action will return FindingsFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

        Returns:
        The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
        See Also:
        FindingsFilterAction

      • actionAsString

        public final String actionAsString()

        The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

        If the service returns an enum value that is not available in the current SDK version, action will return FindingsFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

        Returns:
        The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
        See Also:
        FindingsFilterAction

      • clientToken

        public final String clientToken()

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

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

      • description

        public final String description()

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

        We strongly recommend that you avoid including any sensitive data in the description of a filter. 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:
        A custom description of the filter. The description can contain as many as 512 characters.

        We strongly recommend that you avoid including any sensitive data in the description of a filter. 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.

      • findingCriteria

        public final FindingCriteria findingCriteria()

        The criteria to use to filter findings.

        Returns:
        The criteria to use to filter findings.

      • name

        public final String name()

        A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

        We strongly recommend that you avoid including any sensitive data in the name of a filter. 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:
        A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

        We strongly recommend that you avoid including any sensitive data in the name of a filter. 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.

      • position

        public final Integer position()

        The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

        Returns:
        The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        A map of key-value pairs that specifies the tags to associate with the filter.

        A findings filter 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A map of key-value pairs that specifies the tags to associate with the filter.

        A findings filter 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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object