Package software.amazon.awscdk.services.shield

Interface CfnProtectionGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProtectionGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:39.611Z")
@Stability(Stable)
public interface CfnProtectionGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProtectionGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.shield.*;
 CfnProtectionGroupProps cfnProtectionGroupProps = CfnProtectionGroupProps.builder()
         .aggregation("aggregation")
         .pattern("pattern")
         .protectionGroupId("protectionGroupId")
         // the properties below are optional
         .members(List.of("members"))
         .resourceType("resourceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProtectionGroupProps.Builder	A builder for CfnProtectionGroupProps
static final class	CfnProtectionGroupProps.Jsii$Proxy	An implementation for CfnProtectionGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnProtectionGroupProps.Builder	builder()
String	getAggregation()	Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
default 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	getProtectionGroupId()	The name of the protection group.
default String	getResourceType()	The resource type to include in the protection group.
default List<CfnTag>	getTags()	Key:value pairs associated with an AWS resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregation

@Stability(Stable)
@NotNull
String getAggregation()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-aggregation

getPattern

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-pattern

getProtectionGroupId

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-protectiongroupid

getMembers

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-members

getResourceType

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-resourcetype

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key:value pairs associated with an AWS resource.

The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-tags

builder

@Stability(Stable)
static CfnProtectionGroupProps.Builder builder()

Returns:

a CfnProtectionGroupProps.Builder of CfnProtectionGroupProps