Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Shield.UpdateProtectionGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing protection group. A protection group is 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.

Synopsis

Creating a Request

data UpdateProtectionGroup Source #

See: newUpdateProtectionGroup smart constructor.

Constructors

UpdateProtectionGroup'

Fields

members :: Maybe [Text]
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.
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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Instances

Instances details

ToJSON UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods toJSON :: UpdateProtectionGroup -> Value # toEncoding :: UpdateProtectionGroup -> Encoding # toJSONList :: [UpdateProtectionGroup] -> Value # toEncodingList :: [UpdateProtectionGroup] -> Encoding #
ToHeaders UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods toHeaders :: UpdateProtectionGroup -> [Header] #
ToPath UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods toPath :: UpdateProtectionGroup -> ByteString #
ToQuery UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods toQuery :: UpdateProtectionGroup -> QueryString #
AWSRequest UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Associated Types type AWSResponse UpdateProtectionGroup # Methods request :: (Service -> Service) -> UpdateProtectionGroup -> Request UpdateProtectionGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateProtectionGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateProtectionGroup))) #
Generic UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Associated Types type Rep UpdateProtectionGroup :: Type -> Type # Methods from :: UpdateProtectionGroup -> Rep UpdateProtectionGroup x # to :: Rep UpdateProtectionGroup x -> UpdateProtectionGroup #
Read UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods readsPrec :: Int -> ReadS UpdateProtectionGroup # readList :: ReadS [UpdateProtectionGroup] # readPrec :: ReadPrec UpdateProtectionGroup # readListPrec :: ReadPrec [UpdateProtectionGroup] #
Show UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods showsPrec :: Int -> UpdateProtectionGroup -> ShowS # show :: UpdateProtectionGroup -> String # showList :: [UpdateProtectionGroup] -> ShowS #
NFData UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods rnf :: UpdateProtectionGroup -> () #
Eq UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods (==) :: UpdateProtectionGroup -> UpdateProtectionGroup -> Bool # (/=) :: UpdateProtectionGroup -> UpdateProtectionGroup -> Bool #
Hashable UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods hashWithSalt :: Int -> UpdateProtectionGroup -> Int # hash :: UpdateProtectionGroup -> Int #
type AWSResponse UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup type AWSResponse UpdateProtectionGroup = UpdateProtectionGroupResponse
type Rep UpdateProtectionGroup Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup type Rep UpdateProtectionGroup = D1 ('MetaData "UpdateProtectionGroup" "Amazonka.Shield.UpdateProtectionGroup" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "UpdateProtectionGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtectedResourceType))) :: (S1 ('MetaSel ('Just "protectionGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "aggregation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProtectionGroupAggregation) :: S1 ('MetaSel ('Just "pattern'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProtectionGroupPattern)))))

newUpdateProtectionGroup Source #

Arguments

:: Text	`UpdateProtectionGroup`
-> ProtectionGroupAggregation	`UpdateProtectionGroup`
-> ProtectionGroupPattern	`UpdateProtectionGroup`
-> UpdateProtectionGroup

Create a value of UpdateProtectionGroup 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:

UpdateProtectionGroup, updateProtectionGroup_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.

UpdateProtectionGroup, updateProtectionGroup_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.

UpdateProtectionGroup, updateProtectionGroup_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.

UpdateProtectionGroup, updateProtectionGroup_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.

UpdateProtectionGroup, updateProtectionGroup_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.

Request Lenses

updateProtectionGroup_members :: Lens' UpdateProtectionGroup (Maybe [Text]) Source #

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.

updateProtectionGroup_resourceType :: Lens' UpdateProtectionGroup (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.

updateProtectionGroup_protectionGroupId :: Lens' UpdateProtectionGroup 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.

updateProtectionGroup_aggregation :: Lens' UpdateProtectionGroup 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.

updateProtectionGroup_pattern :: Lens' UpdateProtectionGroup 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Destructuring the Response

data UpdateProtectionGroupResponse Source #

See: newUpdateProtectionGroupResponse smart constructor.

Constructors

UpdateProtectionGroupResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Associated Types type Rep UpdateProtectionGroupResponse :: Type -> Type # Methods from :: UpdateProtectionGroupResponse -> Rep UpdateProtectionGroupResponse x # to :: Rep UpdateProtectionGroupResponse x -> UpdateProtectionGroupResponse #
Read UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods readsPrec :: Int -> ReadS UpdateProtectionGroupResponse # readList :: ReadS [UpdateProtectionGroupResponse] # readPrec :: ReadPrec UpdateProtectionGroupResponse # readListPrec :: ReadPrec [UpdateProtectionGroupResponse] #
Show UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods showsPrec :: Int -> UpdateProtectionGroupResponse -> ShowS # show :: UpdateProtectionGroupResponse -> String # showList :: [UpdateProtectionGroupResponse] -> ShowS #
NFData UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods rnf :: UpdateProtectionGroupResponse -> () #
Eq UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup Methods (==) :: UpdateProtectionGroupResponse -> UpdateProtectionGroupResponse -> Bool # (/=) :: UpdateProtectionGroupResponse -> UpdateProtectionGroupResponse -> Bool #
type Rep UpdateProtectionGroupResponse Source #
Instance details Defined in Amazonka.Shield.UpdateProtectionGroup type Rep UpdateProtectionGroupResponse = D1 ('MetaData "UpdateProtectionGroupResponse" "Amazonka.Shield.UpdateProtectionGroup" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "UpdateProtectionGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateProtectionGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateProtectionGroupResponse'`
-> UpdateProtectionGroupResponse

Create a value of UpdateProtectionGroupResponse 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:httpStatus:UpdateProtectionGroupResponse', updateProtectionGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateProtectionGroupResponse_httpStatus :: Lens' UpdateProtectionGroupResponse Int Source #

The response's http status code.