organization_configurations

Creates, updates, deletes, gets or lists an organization_configurations resource.

Overview

Name	organization_configurations
Type	Resource
Id	aws.securityhub.organization_configurations

Fields

The following fields are returned by SELECT queries:

describe_organization_configuration

Name	Datatype	Description
auto_enable	boolean	Whether to automatically enable Security Hub CSPM in new member accounts when they join the organization. If set to true, then Security Hub CSPM is automatically enabled in new accounts. If set to false, then Security Hub CSPM 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 CSPM is enabled and associate the policy with new organization accounts.
auto_enable_standards	string	Whether to automatically enable Security Hub CSPM default standards in new member accounts when they join the organization. If equal to DEFAULT, then Security Hub CSPM default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts. The default value of this parameter is equal to DEFAULT. 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. (NONE, DEFAULT)
member_account_limit_reached	boolean	Whether the maximum number of allowed member accounts are already associated with the Security Hub CSPM administrator account.
organization_configuration	object	Provides information about the way an organization is configured in Security Hub CSPM.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_organization_configuration	select	region		Returns information about the way your organization is configured in Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.
update_organization_configuration	update	region, AutoEnable		Updates the configuration of your organization in Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_organization_configuration

Returns information about the way your organization is configured in Security Hub CSPM. Only the Security Hub CSPM administrator account can invoke this operation.

SELECT
auto_enable,
auto_enable_standards,
member_account_limit_reached,
organization_configuration
FROM aws.securityhub.organization_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_organization_configuration

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

UPDATE aws.securityhub.organization_configurations
SET 
AutoEnable = {{ AutoEnable }},
AutoEnableStandards = '{{ AutoEnableStandards }}',
OrganizationConfiguration = '{{ OrganizationConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND AutoEnable = {{ AutoEnable }} --required;