Update Organization Configuration

securityhub_update_organization_configuration

R Documentation

Updates the configuration of your organization in Security Hub¶

Description¶

Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.

Usage¶

securityhub_update_organization_configuration(AutoEnable,
  AutoEnableStandards, OrganizationConfiguration)

Arguments¶

AutoEnable

[required] Whether to automatically enable Security Hub in new member accounts when they join the organization.

If set to true, then Security Hub is automatically enabled in new accounts. If set to false, then Security Hub isn't enabled in new accounts automatically. The default value is false.

If the ConfigurationType of your organization is set to CENTRAL, then this field is set to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub is enabled and associate the policy with new organization accounts.

AutoEnableStandards

Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.

The default value of this parameter is equal to DEFAULT.

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts.

If the ConfigurationType of your organization is set to CENTRAL, then this field is set to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.

OrganizationConfiguration

Value¶

An empty list.

Request syntax¶

svc$update_organization_configuration(
  AutoEnable = TRUE|FALSE,
  AutoEnableStandards = "NONE"|"DEFAULT",
  OrganizationConfiguration = list(
    ConfigurationType = "CENTRAL"|"LOCAL",
    Status = "PENDING"|"ENABLED"|"FAILED",
    StatusMessage = "string"
  )
)

Examples¶

## Not run: 
# This operation updates the way your organization is configured in
# Security Hub. Only a Security Hub administrator account can invoke this
# operation.
svc$update_organization_configuration(
  AutoEnable = FALSE,
  AutoEnableStandards = "NONE",
  OrganizationConfiguration = list(
    ConfigurationType = "CENTRAL"
  )
)

## End(Not run)