amazonka-shield-2.0: Amazon Shield SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Shield.Types.ProtectionGroup

Description

 
Synopsis

Documentation

data ProtectionGroup Source #

A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

See: newProtectionGroup smart constructor.

Constructors

ProtectionGroup' 

Fields

  • protectionGroupArn :: Maybe Text

    The ARN (Amazon Resource Name) of the protection group.

  • resourceType :: Maybe ProtectedResourceType

    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.

  • protectionGroupId :: Text

    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.

  • aggregation :: ProtectionGroupAggregation

    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 distributions and origin resources for CloudFront distributions.
  • pattern' :: ProtectionGroupPattern

    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.

  • members :: [Text]

    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.

Instances

Instances details
FromJSON ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

Generic ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

Associated Types

type Rep ProtectionGroup :: Type -> Type #

Read ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

Show ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

NFData ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

Methods

rnf :: ProtectionGroup -> () #

Eq ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

Hashable ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

type Rep ProtectionGroup Source # 
Instance details

Defined in Amazonka.Shield.Types.ProtectionGroup

newProtectionGroup Source #

Create a value of ProtectionGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:protectionGroupArn:ProtectionGroup', protectionGroup_protectionGroupArn - The ARN (Amazon Resource Name) of the protection group.

$sel:resourceType:ProtectionGroup', protectionGroup_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.

$sel:protectionGroupId:ProtectionGroup', protectionGroup_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.

$sel:aggregation:ProtectionGroup', protectionGroup_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 distributions and origin resources for CloudFront distributions.

$sel:pattern':ProtectionGroup', protectionGroup_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.

$sel:members:ProtectionGroup', protectionGroup_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.

protectionGroup_protectionGroupArn :: Lens' ProtectionGroup (Maybe Text) Source #

The ARN (Amazon Resource Name) of the protection group.

protectionGroup_resourceType :: Lens' ProtectionGroup (Maybe ProtectedResourceType) Source #

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.

protectionGroup_protectionGroupId :: Lens' ProtectionGroup Text Source #

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.

protectionGroup_aggregation :: Lens' ProtectionGroup ProtectionGroupAggregation Source #

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

protectionGroup_pattern :: Lens' ProtectionGroup ProtectionGroupPattern Source #

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.

protectionGroup_members :: Lens' ProtectionGroup [Text] Source #

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.