Package software.amazon.awssdk.services.shield.model

Class CreateProtectionGroupRequest

    • Method Detail

      • 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 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 and origin resources for CloudFront distributions.

        See Also:
        ProtectionGroupAggregation

      • 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 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 and origin resources for CloudFront distributions.

        See Also:
        ProtectionGroupAggregation

      • 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.
        See Also:
        ProtectionGroupPattern

      • 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.
        See Also:
        ProtectionGroupPattern

      • 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. Newly protected resources of this type are automatically added to the 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. Newly protected resources of this type are automatically added to the 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:
        ProtectedResourceType

      • 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. Newly protected resources of this type are automatically added to the 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. Newly protected resources of this type are automatically added to the 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:
        ProtectedResourceType

      • 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 Amazon Resource Names (ARNs) 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 Amazon Resource Names (ARNs) 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.

      • 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 List<Tag> tags()

        One or more tag key-value pairs for the protection group.

        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:
        One or more tag key-value pairs for the protection group.

      • 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