CreateProtectionGroupRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.shield.model.ShieldRequest
    - - software.amazon.awssdk.services.shield.model.CreateProtectionGroupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateProtectionGroupRequest
extends ShieldRequest
implements ToCopyableBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateProtectionGroupRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateProtectionGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProtectionGroupAggregation`	`aggregation()` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`String`	`aggregationAsString()` Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
`static CreateProtectionGroupRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMembers()` For responses, this returns true if the service returned a value for the Members property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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`	`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 CreateProtectionGroupRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` One or more tag key-value pairs for the protection group.
`CreateProtectionGroupRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 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.
  - toBuilder
```
public CreateProtectionGroupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateProtectionGroupRequest.Builder,CreateProtectionGroupRequest>
    
    Specified by:
    
    toBuilder in class ShieldRequest
  - builder
```
public static CreateProtectionGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateProtectionGroupRequest.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

Class CreateProtectionGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

protectionGroupId

aggregation

aggregationAsString

pattern

patternAsString

resourceType

resourceTypeAsString

hasMembers

members

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields