AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . securityhub ]
Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region.
You can invoke this operation from the current home Region only.
See also: AWS API Documentation
update-finding-aggregator
--finding-aggregator-arn <value>
--region-linking-mode <value>
[--regions <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--finding-aggregator-arn
(string)
The ARN of the finding aggregator. To obtain the ARN, useListFindingAggregators
.
--region-linking-mode
(string)
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
- Aggregates 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
- Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in theRegions
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
- Aggregates findings only from the Regions listed in theRegions
parameter. Security Hub does not automatically aggregate findings from new Regions.NO_REGIONS
- Aggregates no data because no Regions are selected as linked Regions.
--regions
(list)
If
RegionLinkingMode
isALL_REGIONS_EXCEPT_SPECIFIED
, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.If
RegionLinkingMode
isSPECIFIED_REGIONS
, then this is a space-separated list of Regions that do replicate and send findings to the home Region.An
InvalidInputException
error results if you populate this field whileRegionLinkingMode
isNO_REGIONS
.(string)
Syntax:
"string" "string" ...
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To update the current finding aggregation configuration
The following update-finding-aggregator
example changes the finding aggregation configuration to link from selected Regions. It is run from US East (Virginia), which is the aggregation Region. It selects US West (N. California) and US West (Oregon) as the linked Regions.
aws securityhub update-finding-aggregator \
--region us-east-1 \
--finding-aggregator-arn arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/123e4567-e89b-12d3-a456-426652340000 \
--region-linking-mode SPECIFIED_REGIONS \
--regions us-west-1,us-west-2
This command produces no output.
For more information, see Updating the finding aggregation configuration in the AWS Security Hub User Guide.
FindingAggregatorArn -> (string)
The ARN of the finding aggregator.
FindingAggregationRegion -> (string)
The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
RegionLinkingMode -> (string)
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
Regions -> (list)
The list of excluded Regions or included Regions.
(string)