ProtectionGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.shield.model.ProtectionGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProtectionGroup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProtectionGroup()

Constructors
Constructor and Description
`ProtectionGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProtectionGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAggregation()` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`List<String>`	`getMembers()` The ARNs (Amazon Resource Names) of the resources to include in the protection group.
`String`	`getPattern()` The criteria to use to choose the protected resources for inclusion in the group.
`String`	`getProtectionGroupArn()` The ARN (Amazon Resource Name) of the protection group.
`String`	`getProtectionGroupId()` The name of the protection group.
`String`	`getResourceType()` The resource type to include in the protection group.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAggregation(String aggregation)` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`void`	`setMembers(Collection<String> members)` The ARNs (Amazon Resource Names) of the resources to include in the protection group.
`void`	`setPattern(String pattern)` The criteria to use to choose the protected resources for inclusion in the group.
`void`	`setProtectionGroupArn(String protectionGroupArn)` The ARN (Amazon Resource Name) of the protection group.
`void`	`setProtectionGroupId(String protectionGroupId)` The name of the protection group.
`void`	`setResourceType(String resourceType)` The resource type to include in the protection group.
`String`	`toString()` Returns a string representation of this object.
`ProtectionGroup`	`withAggregation(ProtectionGroupAggregation aggregation)` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`ProtectionGroup`	`withAggregation(String aggregation)` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`ProtectionGroup`	`withMembers(Collection<String> members)` The ARNs (Amazon Resource Names) of the resources to include in the protection group.
`ProtectionGroup`	`withMembers(String... members)` The ARNs (Amazon Resource Names) of the resources to include in the protection group.
`ProtectionGroup`	`withPattern(ProtectionGroupPattern pattern)` The criteria to use to choose the protected resources for inclusion in the group.
`ProtectionGroup`	`withPattern(String pattern)` The criteria to use to choose the protected resources for inclusion in the group.
`ProtectionGroup`	`withProtectionGroupArn(String protectionGroupArn)` The ARN (Amazon Resource Name) of the protection group.
`ProtectionGroup`	`withProtectionGroupId(String protectionGroupId)` The name of the protection group.
`ProtectionGroup`	`withResourceType(ProtectedResourceType resourceType)` The resource type to include in the protection group.
`ProtectionGroup`	`withResourceType(String resourceType)` The resource type to include in the protection group.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProtectionGroup
```
public ProtectionGroup()
```
- Method Detail
  - setProtectionGroupId
```
public void setProtectionGroupId(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.
    
    Parameters:
    
    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.
  - getProtectionGroupId
```
public String getProtectionGroupId()
```
    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.
  - withProtectionGroupId
```
public ProtectionGroup withProtectionGroupId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAggregation
```
public void setAggregation(String 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.
    Parameters:
    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.
    See Also:
    
    ProtectionGroupAggregation
  - getAggregation
```
public String getAggregation()
```
    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.
    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:
    
    ProtectionGroupAggregation
  - withAggregation
```
public ProtectionGroup withAggregation(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectionGroupAggregation
  - withAggregation
```
public ProtectionGroup withAggregation(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectionGroupAggregation
  - setPattern
```
public void setPattern(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ProtectionGroupPattern
  - getPattern
```
public String getPattern()
```
    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.
    
    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:
    
    ProtectionGroupPattern
  - withPattern
```
public ProtectionGroup withPattern(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectionGroupPattern
  - withPattern
```
public ProtectionGroup withPattern(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectionGroupPattern
  - setResourceType
```
public void setResourceType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ProtectedResourceType
  - getResourceType
```
public String getResourceType()
```
    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.
    
    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
  - withResourceType
```
public ProtectionGroup withResourceType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectedResourceType
  - withResourceType
```
public ProtectionGroup withResourceType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtectedResourceType
  - getMembers
```
public List<String> getMembers()
```
    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.
    
    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.
  - setMembers
```
public void setMembers(Collection<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.
    
    Parameters:
    
    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.
  - withMembers
```
public ProtectionGroup withMembers(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMembers(java.util.Collection) or withMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMembers
```
public ProtectionGroup withMembers(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtectionGroupArn
```
public void setProtectionGroupArn(String protectionGroupArn)
```
    The ARN (Amazon Resource Name) of the protection group.
    
    Parameters:
    
    protectionGroupArn - The ARN (Amazon Resource Name) of the protection group.
  - getProtectionGroupArn
```
public String getProtectionGroupArn()
```
    The ARN (Amazon Resource Name) of the protection group.
    
    Returns:
    
    The ARN (Amazon Resource Name) of the protection group.
  - withProtectionGroupArn
```
public ProtectionGroup withProtectionGroupArn(String protectionGroupArn)
```
    The ARN (Amazon Resource Name) of the protection group.
    
    Parameters:
    
    protectionGroupArn - The ARN (Amazon Resource Name) of the protection group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProtectionGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class ProtectionGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProtectionGroup

Method Detail

setProtectionGroupId

getProtectionGroupId

withProtectionGroupId

setAggregation

getAggregation

withAggregation

withAggregation

setPattern

getPattern

withPattern

withPattern

setResourceType

getResourceType

withResourceType

withResourceType

getMembers

setMembers

withMembers

withMembers

setProtectionGroupArn

getProtectionGroupArn

withProtectionGroupArn

toString

equals

hashCode

clone

marshall