[ aws . securityhub ]

update-organization-configuration

Description

Used to update the configuration related to Organizations. Can only be called from a Security Hub administrator account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-organization-configuration
--auto-enable | --no-auto-enable
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--auto-enable | --no-auto-enable (boolean)

Whether to automatically enable Security Hub for new accounts in the organization.

By default, this is false , and new accounts are not added automatically.

To automatically enable Security Hub for new accounts, set this to true .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To configure Security Hub to automatically enable new organization accounts

The following update-organization-configuration example configures Security Hub to automatically enable new accounts in an organization.

aws securityhub update-organization-configuration \
    --auto-enable

This command produces no output.

For more information, see Automatically enabling new organization accounts in the AWS Security Hub User Guide.

Output

None