Package software.amazon.awscdk.services.shield

Class CfnProtectionGroup.Builder

java.lang.Object

software.amazon.awscdk.services.shield.CfnProtectionGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProtectionGroup>

Enclosing class:

CfnProtectionGroup

@Stability(Stable)
public static final class CfnProtectionGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProtectionGroup>

A fluent builder for CfnProtectionGroup.

Method Summary

Modifier and Type	Method	Description
CfnProtectionGroup.Builder	aggregation(String aggregation)	Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
CfnProtectionGroup	build()
static CfnProtectionGroup.Builder	create(software.constructs.Construct scope, String id)
CfnProtectionGroup.Builder	members(List<String> members)	The ARNs (Amazon Resource Names) of the resources to include in the protection group.
CfnProtectionGroup.Builder	pattern(String pattern)	The criteria to use to choose the protected resources for inclusion in the group.
CfnProtectionGroup.Builder	protectionGroupId(String protectionGroupId)	The name of the protection group.
CfnProtectionGroup.Builder	resourceType(String resourceType)	The resource type to include in the protection group.
CfnProtectionGroup.Builder	tags(List<? extends CfnTag> tags)	Key:value pairs associated with an AWS resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnProtectionGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnProtectionGroup.Builder.

aggregation

@Stability(Stable)
public CfnProtectionGroup.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 Amazon 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. This parameter is required.

Returns:

this

See Also:

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

pattern

@Stability(Stable)
public CfnProtectionGroup.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 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. This parameter is required.

Returns:

this

See Also:

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

protectionGroupId

@Stability(Stable)
public CfnProtectionGroup.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. This parameter is required.

Returns:

this

See Also:

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

members

@Stability(Stable)
public CfnProtectionGroup.Builder members(List<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. This parameter is required.

Returns:

this

See Also:

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

resourceType

@Stability(Stable)
public CfnProtectionGroup.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. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnProtectionGroup.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - Key:value pairs associated with an AWS resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnProtectionGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnProtectionGroup>

Returns:

a newly built instance of CfnProtectionGroup.