Package software.amazon.awssdk.services.securityhub.model

Class UpdateFindingAggregatorRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.securityhub.model.SecurityHubRequest
software.amazon.awssdk.services.securityhub.model.UpdateFindingAggregatorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateFindingAggregatorRequest.Builder,UpdateFindingAggregatorRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFindingAggregatorRequest extends SecurityHubRequest implements ToCopyableBuilder<UpdateFindingAggregatorRequest.Builder,UpdateFindingAggregatorRequest>

  • Method Details

    • findingAggregatorArn

      public final String findingAggregatorArn()

      The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

      Returns:
      The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.

    • regionLinkingMode

      public final String regionLinkingMode()

      Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them.

      The selected option also determines how to use the Regions provided in the Regions list.

      The options are as follows:

      • ALL_REGIONS - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.

      • ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.

      • SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.

      • NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

      Returns:
      Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub CSPM supports them and you opt into them.

      The selected option also determines how to use the Regions provided in the Regions list.

      The options are as follows:

      • ALL_REGIONS - Aggregates findings from all of the Regions where Security Hub CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.

      • ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.

      • SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.

      • NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions 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.

    • regions

      public final List<String> regions()

      If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.

      If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.

      An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.

      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 hasRegions() method.

      Returns:
      If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.

      If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.

      An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.

    • toBuilder

      public UpdateFindingAggregatorRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateFindingAggregatorRequest.Builder,UpdateFindingAggregatorRequest>
      Specified by:
      toBuilder in class SecurityHubRequest

    • builder

      public static UpdateFindingAggregatorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFindingAggregatorRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo