Enable Security Hub
securityhub_enable_security_hub | R Documentation |
Enables Security Hub for your account in the current Region or the Region you specify in the request¶
Description¶
Enables Security Hub for your account in the current Region or the Region you specify in the request.
When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub.
When you use the enable_security_hub
operation to enable Security Hub,
you also automatically enable the following standards:
-
Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0
-
Amazon Web Services Foundational Security Best Practices
Other standards are not automatically enabled.
To opt out of automatically enabled standards, set
EnableDefaultStandards
to false
.
After you enable Security Hub, to enable a standard, use the
batch_enable_standards
operation. To disable a standard, use the
batch_disable_standards
operation.
To learn more, see the setup information in the Security Hub User Guide.
Usage¶
Arguments¶
Tags
The tags to add to the hub resource when you enable Security Hub.
EnableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for
EnableDefaultStandards
, it is set totrue
. To not enable the automatically enabled standards, setEnableDefaultStandards
tofalse
.ControlFindingGenerator
This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to
SECURITY_CONTROL
, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards.If the value for this field is set to
STANDARD_CONTROL
, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards.The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is
SECURITY_CONTROL
if you enabled Security Hub on or after February 23, 2023.
Value¶
An empty list.
Request syntax¶
svc$enable_security_hub(
Tags = list(
"string"
),
EnableDefaultStandards = TRUE|FALSE,
ControlFindingGenerator = "STANDARD_CONTROL"|"SECURITY_CONTROL"
)
Examples¶
## Not run:
# The following example activates the Security Hub service in the
# requesting AWS account. The service is activated in the current AWS
# Region or the Region that you specify in the request. Some standards are
# automatically turned on in your account unless you opt out. To determine
# which standards are automatically turned on, see the Security Hub
# documentation.
svc$enable_security_hub(
EnableDefaultStandards = TRUE,
Tags = list(
Department = "Security"
)
)
## End(Not run)