com.amazonaws.services.shield.model

Class CreateProtectionGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.shield.model.CreateProtectionGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateProtectionGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateProtectionGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateProtectionGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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 Amazon Resource Names (ARNs) 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	getProtectionGroupId() The name of the protection group.
String	getResourceType() The resource type to include in the protection group.
List<Tag>	getTags() One or more tag key-value pairs for the protection group.
int	hashCode()
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 Amazon Resource Names (ARNs) 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	setProtectionGroupId(String protectionGroupId) The name of the protection group.
void	setResourceType(String resourceType) The resource type to include in the protection group.
void	setTags(Collection<Tag> tags) One or more tag key-value pairs for the protection group.
String	toString() Returns a string representation of this object.
CreateProtectionGroupRequest	withAggregation(ProtectionGroupAggregation aggregation) Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
CreateProtectionGroupRequest	withAggregation(String aggregation) Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
CreateProtectionGroupRequest	withMembers(Collection<String> members) The Amazon Resource Names (ARNs) of the resources to include in the protection group.
CreateProtectionGroupRequest	withMembers(String... members) The Amazon Resource Names (ARNs) of the resources to include in the protection group.
CreateProtectionGroupRequest	withPattern(ProtectionGroupPattern pattern) The criteria to use to choose the protected resources for inclusion in the group.
CreateProtectionGroupRequest	withPattern(String pattern) The criteria to use to choose the protected resources for inclusion in the group.
CreateProtectionGroupRequest	withProtectionGroupId(String protectionGroupId) The name of the protection group.
CreateProtectionGroupRequest	withResourceType(ProtectedResourceType resourceType) The resource type to include in the protection group.
CreateProtectionGroupRequest	withResourceType(String resourceType) The resource type to include in the protection group.
CreateProtectionGroupRequest	withTags(Collection<Tag> tags) One or more tag key-value pairs for the protection group.
CreateProtectionGroupRequest	withTags(Tag... tags) One or more tag key-value pairs for the protection group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateProtectionGroupRequest

public CreateProtectionGroupRequest()

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

See Also:

ProtectionGroupAggregation

withAggregation

public CreateProtectionGroupRequest 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 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 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 CreateProtectionGroupRequest 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 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 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.

See Also:

ProtectionGroupPattern

withPattern

public CreateProtectionGroupRequest 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), 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 CreateProtectionGroupRequest 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 Amazon Resource Names (ARNs), 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 Amazon Resource Names (ARNs), 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. 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.

Parameters:

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.

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

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

withResourceType

public CreateProtectionGroupRequest withResourceType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProtectedResourceType

withResourceType

public CreateProtectionGroupRequest withResourceType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProtectedResourceType

getMembers

public List<String> getMembers()

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.

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.

setMembers

public void setMembers(Collection<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.

Parameters:

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.

withMembers

public CreateProtectionGroupRequest withMembers(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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withMembers

public CreateProtectionGroupRequest withMembers(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateProtectionGroupRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateProtectionGroupRequest withTags(Collection<Tag> tags)

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

Parameters:

tags - One or more tag key-value pairs for 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 CreateProtectionGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()