Package software.amazon.awscdk.services.shield

Class CfnProtectionGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.shield.CfnProtectionGroup
All Implemented Interfaces:
IInspectable, ITaggableV2, IProtectionGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.431Z") @Stability(Stable) public class CfnProtectionGroup extends CfnResource implements IInspectable, IProtectionGroupRef, ITaggableV2
Creates a grouping of protected resources so they can be handled as a collective.

This resource grouping improves the accuracy of detection and reduces false positives.

To configure this resource through AWS CloudFormation , you must be subscribed to AWS Shield Advanced . You can subscribe through the Shield Advanced console and through the APIs. For more information, see Subscribe to AWS Shield Advanced .

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.*;
 CfnProtectionGroup cfnProtectionGroup = CfnProtectionGroup.Builder.create(this, "MyCfnProtectionGroup")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProtectionGroup

      protected CfnProtectionGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProtectionGroup

      protected CfnProtectionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProtectionGroup

      @Stability(Stable) public CfnProtectionGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProtectionGroupProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrProtectionGroupArn

      @Stability(Stable) @NotNull public String getAttrProtectionGroupArn()
      The ARN (Amazon Resource Name) of the new protection group.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getProtectionGroupRef

      @Stability(Stable) @NotNull public ProtectionGroupReference getProtectionGroupRef()
      A reference to a ProtectionGroup resource.
      Specified by:
      getProtectionGroupRef in interface IProtectionGroupRef

    • getAggregation

      @Stability(Stable) @NotNull public String getAggregation()
      Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.

    • setAggregation

      @Stability(Stable) public void setAggregation(@NotNull String value)
      Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.

    • getPattern

      @Stability(Stable) @NotNull public String getPattern()
      The criteria to use to choose the protected resources for inclusion in the group.

    • setPattern

      @Stability(Stable) public void setPattern(@NotNull String value)
      The criteria to use to choose the protected resources for inclusion in the group.

    • getProtectionGroupId

      @Stability(Stable) @NotNull public String getProtectionGroupId()
      The name of the protection group.

    • setProtectionGroupId

      @Stability(Stable) public void setProtectionGroupId(@NotNull String value)
      The name of the protection group.

    • getMembers

      @Stability(Stable) @Nullable public List<String> getMembers()
      The ARNs (Amazon Resource Names) of the resources to include in the protection group.

    • setMembers

      @Stability(Stable) public void setMembers(@Nullable List<String> value)
      The ARNs (Amazon Resource Names) of the resources to include in the protection group.

    • getResourceType

      @Stability(Stable) @Nullable public String getResourceType()
      The resource type to include in the protection group.

    • setResourceType

      @Stability(Stable) public void setResourceType(@Nullable String value)
      The resource type to include in the protection group.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Key:value pairs associated with an AWS resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Key:value pairs associated with an AWS resource.