software.amazon.awssdk.services.shield.model

Interface ProtectionGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>, SdkBuilder<ProtectionGroup.Builder,ProtectionGroup>, SdkPojo

Enclosing class:

ProtectionGroup

public static interface ProtectionGroup.Builder
extends SdkPojo, CopyableBuilder<ProtectionGroup.Builder,ProtectionGroup>

Method Summary

Modifier and Type	Method and Description
ProtectionGroup.Builder	aggregation(ProtectionGroupAggregation aggregation) Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
ProtectionGroup.Builder	aggregation(String aggregation) Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
ProtectionGroup.Builder	members(Collection<String> members) The Amazon Resource Names (ARNs) of the resources to include in the protection group.
ProtectionGroup.Builder	members(String... members) The Amazon Resource Names (ARNs) of the resources to include in the protection group.
ProtectionGroup.Builder	pattern(ProtectionGroupPattern pattern) The criteria to use to choose the protected resources for inclusion in the group.
ProtectionGroup.Builder	pattern(String pattern) The criteria to use to choose the protected resources for inclusion in the group.
ProtectionGroup.Builder	protectionGroupArn(String protectionGroupArn) The ARN (Amazon Resource Name) of the protection group.
ProtectionGroup.Builder	protectionGroupId(String protectionGroupId) The name of the protection group.
ProtectionGroup.Builder	resourceType(ProtectedResourceType resourceType) The resource type to include in the protection group.
ProtectionGroup.Builder	resourceType(String resourceType) The resource type to include in the protection group.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

protectionGroupId

ProtectionGroup.Builder protectionGroupId(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.

aggregation

ProtectionGroup.Builder aggregation(String 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.

Parameters:

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.

Returns:

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

See Also:

ProtectionGroupAggregation, ProtectionGroupAggregation

aggregation

ProtectionGroup.Builder aggregation(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.

Parameters:

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.

Returns:

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

See Also:

ProtectionGroupAggregation, ProtectionGroupAggregation

pattern

ProtectionGroup.Builder pattern(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, ProtectionGroupPattern

pattern

ProtectionGroup.Builder pattern(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, ProtectionGroupPattern

resourceType

ProtectionGroup.Builder resourceType(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, ProtectedResourceType

resourceType

ProtectionGroup.Builder resourceType(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, ProtectedResourceType

members

ProtectionGroup.Builder members(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.

members

ProtectionGroup.Builder members(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.

protectionGroupArn

ProtectionGroup.Builder protectionGroupArn(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.