Skip to content

OrganizationConfiguration

Source code in docs_src/capo_securityhub/types/organization_configuration.py
class OrganizationConfiguration(TypedDict, closed=True):
    configuration_type: NotRequired[
        "capo_securityhub.types.organization_configuration_configuration_type.OrganizationConfigurationConfigurationType"
    ]
    """<p> Indicates whether the organization uses local or central configuration. </p> <p>If you use local configuration, the Security Hub CSPM delegated administrator can set <code>AutoEnable</code> to <code>true</code> and <code>AutoEnableStandards</code> to <code>DEFAULT</code>. This automatically enables Security Hub CSPM and default security standards in new organization accounts. These new account settings must be set separately in each Amazon Web Services Region, and settings may be different in each Region. </p> <p> If you use central configuration, the delegated administrator can create configuration policies. Configuration policies can be used to configure Security Hub CSPM, security standards, and security controls in multiple accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a configuration policy and associate it with the root or specific organizational units (OUs). New accounts will inherit the policy from the root or their assigned OU. </p>"""
    status: NotRequired[
        "capo_securityhub.types.organization_configuration_status.OrganizationConfigurationStatus"
    ]
    """<p> Describes whether central configuration could be enabled as the <code>ConfigurationType</code> for the organization. If your <code>ConfigurationType</code> is local configuration, then the value of <code>Status</code> is always <code>ENABLED</code>. </p>"""
    status_message: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> Provides an explanation if the value of <code>Status</code> is equal to <code>FAILED</code> when <code>ConfigurationType</code> is equal to <code>CENTRAL</code>. </p>"""

configuration_type instance-attribute

configuration_type: NotRequired[OrganizationConfigurationConfigurationType]

Indicates whether the organization uses local or central configuration.

If you use local configuration, the Security Hub CSPM delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub CSPM and default security standards in new organization accounts. These new account settings must be set separately in each Amazon Web Services Region, and settings may be different in each Region.

If you use central configuration, the delegated administrator can create configuration policies. Configuration policies can be used to configure Security Hub CSPM, security standards, and security controls in multiple accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a configuration policy and associate it with the root or specific organizational units (OUs). New accounts will inherit the policy from the root or their assigned OU.

status instance-attribute

status: NotRequired[OrganizationConfigurationStatus]

Describes whether central configuration could be enabled as the ConfigurationType for the organization. If your ConfigurationType is local configuration, then the value of Status is always ENABLED.

status_message instance-attribute

status_message: NotRequired[NonEmptyString]

Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.