Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.CreateFindingAggregator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.

Synopsis

Creating a Request

data CreateFindingAggregator Source #

See: newCreateFindingAggregator smart constructor.

Constructors

CreateFindingAggregator'

Fields

regions :: Maybe [Text]
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
regionLinkingMode :: Text
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
- ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
- ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
- SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Instances

Instances details

Eq CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods (==) :: CreateFindingAggregator -> CreateFindingAggregator -> Bool # (/=) :: CreateFindingAggregator -> CreateFindingAggregator -> Bool #
Read CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods readsPrec :: Int -> ReadS CreateFindingAggregator # readList :: ReadS [CreateFindingAggregator] # readPrec :: ReadPrec CreateFindingAggregator # readListPrec :: ReadPrec [CreateFindingAggregator] #
Show CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods showsPrec :: Int -> CreateFindingAggregator -> ShowS # show :: CreateFindingAggregator -> String # showList :: [CreateFindingAggregator] -> ShowS #
Generic CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Associated Types type Rep CreateFindingAggregator :: Type -> Type # Methods from :: CreateFindingAggregator -> Rep CreateFindingAggregator x # to :: Rep CreateFindingAggregator x -> CreateFindingAggregator #
NFData CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods rnf :: CreateFindingAggregator -> () #
Hashable CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods hashWithSalt :: Int -> CreateFindingAggregator -> Int # hash :: CreateFindingAggregator -> Int #
ToJSON CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods toJSON :: CreateFindingAggregator -> Value # toEncoding :: CreateFindingAggregator -> Encoding # toJSONList :: [CreateFindingAggregator] -> Value # toEncodingList :: [CreateFindingAggregator] -> Encoding #
AWSRequest CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Associated Types type AWSResponse CreateFindingAggregator # Methods request :: CreateFindingAggregator -> Request CreateFindingAggregator # response :: MonadResource m => Logger -> Service -> Proxy CreateFindingAggregator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFindingAggregator))) #
ToHeaders CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods toHeaders :: CreateFindingAggregator -> [Header] #
ToPath CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods toPath :: CreateFindingAggregator -> ByteString #
ToQuery CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods toQuery :: CreateFindingAggregator -> QueryString #
type Rep CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator type Rep CreateFindingAggregator = D1 ('MetaData "CreateFindingAggregator" "Amazonka.SecurityHub.CreateFindingAggregator" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateFindingAggregator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "regionLinkingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateFindingAggregator Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator type AWSResponse CreateFindingAggregator = CreateFindingAggregatorResponse

newCreateFindingAggregator Source #

Arguments

:: Text	`$sel:regionLinkingMode:CreateFindingAggregator'`
-> CreateFindingAggregator

Create a value of CreateFindingAggregator 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:regions:CreateFindingAggregator', createFindingAggregator_regions - If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.

$sel:regionLinkingMode:CreateFindingAggregator', createFindingAggregator_regionLinkingMode - Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

The selected option also determines how to use the Regions provided in the Regions list.

The options are as follows:

ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Request Lenses

createFindingAggregator_regions :: Lens' CreateFindingAggregator (Maybe [Text]) Source #

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.

createFindingAggregator_regionLinkingMode :: Lens' CreateFindingAggregator Text Source #

Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

The selected option also determines how to use the Regions provided in the Regions list.

The options are as follows:

ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Destructuring the Response

data CreateFindingAggregatorResponse Source #

See: newCreateFindingAggregatorResponse smart constructor.

Constructors

CreateFindingAggregatorResponse'

Fields

regions :: Maybe [Text]
The list of excluded Regions or included Regions.
findingAggregatorArn :: Maybe Text
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
regionLinkingMode :: Maybe Text
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
findingAggregationRegion :: Maybe Text
The aggregation Region.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods (==) :: CreateFindingAggregatorResponse -> CreateFindingAggregatorResponse -> Bool # (/=) :: CreateFindingAggregatorResponse -> CreateFindingAggregatorResponse -> Bool #
Read CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods readsPrec :: Int -> ReadS CreateFindingAggregatorResponse # readList :: ReadS [CreateFindingAggregatorResponse] # readPrec :: ReadPrec CreateFindingAggregatorResponse # readListPrec :: ReadPrec [CreateFindingAggregatorResponse] #
Show CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods showsPrec :: Int -> CreateFindingAggregatorResponse -> ShowS # show :: CreateFindingAggregatorResponse -> String # showList :: [CreateFindingAggregatorResponse] -> ShowS #
Generic CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Associated Types type Rep CreateFindingAggregatorResponse :: Type -> Type # Methods from :: CreateFindingAggregatorResponse -> Rep CreateFindingAggregatorResponse x # to :: Rep CreateFindingAggregatorResponse x -> CreateFindingAggregatorResponse #
NFData CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator Methods rnf :: CreateFindingAggregatorResponse -> () #
type Rep CreateFindingAggregatorResponse Source #
Instance details Defined in Amazonka.SecurityHub.CreateFindingAggregator type Rep CreateFindingAggregatorResponse = D1 ('MetaData "CreateFindingAggregatorResponse" "Amazonka.SecurityHub.CreateFindingAggregator" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateFindingAggregatorResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "findingAggregatorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionLinkingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "findingAggregationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateFindingAggregatorResponse Source #

Arguments

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

Create a value of CreateFindingAggregatorResponse 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:regions:CreateFindingAggregator', createFindingAggregatorResponse_regions - The list of excluded Regions or included Regions.

$sel:findingAggregatorArn:CreateFindingAggregatorResponse', createFindingAggregatorResponse_findingAggregatorArn - The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

$sel:regionLinkingMode:CreateFindingAggregator', createFindingAggregatorResponse_regionLinkingMode - Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

$sel:findingAggregationRegion:CreateFindingAggregatorResponse', createFindingAggregatorResponse_findingAggregationRegion - The aggregation Region.

$sel:httpStatus:CreateFindingAggregatorResponse', createFindingAggregatorResponse_httpStatus - The response's http status code.

Response Lenses

createFindingAggregatorResponse_regions :: Lens' CreateFindingAggregatorResponse (Maybe [Text]) Source #

The list of excluded Regions or included Regions.

createFindingAggregatorResponse_findingAggregatorArn :: Lens' CreateFindingAggregatorResponse (Maybe Text) Source #

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

createFindingAggregatorResponse_regionLinkingMode :: Lens' CreateFindingAggregatorResponse (Maybe Text) Source #

Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.

createFindingAggregatorResponse_findingAggregationRegion :: Lens' CreateFindingAggregatorResponse (Maybe Text) Source #

The aggregation Region.

createFindingAggregatorResponse_httpStatus :: Lens' CreateFindingAggregatorResponse Int Source #

The response's http status code.