software.amazon.awssdk.services.shield.model

Class ProtectionGroup

java.lang.Object

software.amazon.awssdk.services.shield.model.ProtectionGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>

@Generated(value="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 AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProtectionGroup.Builder

Method Summary

Modifier and Type	Method and Description
ProtectionGroupAggregation	aggregation() Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
String	aggregationAsString() Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
static ProtectionGroup.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMembers() Returns true if the Members property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	members() The Amazon Resource Names (ARNs) of the resources to include in the protection group.
ProtectionGroupPattern	pattern() The criteria to use to choose the protected resources for inclusion in the group.
String	patternAsString() The criteria to use to choose the protected resources for inclusion in the group.
String	protectionGroupArn() The ARN (Amazon Resource Name) of the protection group.
String	protectionGroupId() The name of the protection group.
ProtectedResourceType	resourceType() The resource type to include in the protection group.
String	resourceTypeAsString() The resource type to include in the protection group.
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectionGroup.Builder>	serializableBuilderClass()
ProtectionGroup.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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

See Also:

ProtectionGroupAggregation

aggregationAsString

public final String aggregationAsString()

Defines how AWS 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 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 AWS 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 CloudFront distributions 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. 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:

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. 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:

ProtectedResourceType

hasMembers

public final boolean hasMembers()

Returns true if the Members property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasMembers() to see if a value was sent in this field.

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.

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

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo