Class ProtectionGroup

java.lang.Object
software.amazon.awssdk.services.shield.model.ProtectionGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>
@Generated("software.amazon.awssdk:codegen") public final class ProtectionGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>

A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

See Also:

  • Method Details

    • protectionGroupId

      public final String protectionGroupId()

      The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

      Returns:
      The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

    • aggregation

      public final ProtectionGroupAggregation aggregation()

      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

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

      Returns:
      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

      See Also:

    • aggregationAsString

      public final String aggregationAsString()

      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

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

      Returns:
      Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

      • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

      • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

      • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

      See Also:

    • pattern

      public final ProtectionGroupPattern pattern()

      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.

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

      Returns:
      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
      See Also:

    • patternAsString

      public final String patternAsString()

      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.

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

      Returns:
      The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
      See Also:

    • resourceType

      public final ProtectedResourceType resourceType()

      The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

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

      Returns:
      The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

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

      Returns:
      The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
      See Also:

    • hasMembers

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

    • members

      public final List<String> members()

      The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

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

      Returns:
      The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

    • protectionGroupArn

      public final String protectionGroupArn()

      The ARN (Amazon Resource Name) of the protection group.

      Returns:
      The ARN (Amazon Resource Name) of the protection group.

    • toBuilder

      public ProtectionGroup.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>
      Returns:
      a builder for type T

    • builder

      public static ProtectionGroup.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.