Package software.amazon.awssdk.services.securityhub.model

Class OrganizationConfiguration

java.lang.Object
software.amazon.awssdk.services.securityhub.model.OrganizationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OrganizationConfiguration.Builder,OrganizationConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OrganizationConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationConfiguration.Builder,OrganizationConfiguration>

Provides information about the way an organization is configured in Security Hub.

See Also:

  • Method Details

    • configurationType

      public final OrganizationConfigurationConfigurationType configurationType()

      Indicates whether the organization uses local or central configuration.

      If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub 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, 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.

      If the service returns an enum value that is not available in the current SDK version, configurationType will return OrganizationConfigurationConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

      Returns:
      Indicates whether the organization uses local or central configuration.

      If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub 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, 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.

      See Also:

    • configurationTypeAsString

      public final String configurationTypeAsString()

      Indicates whether the organization uses local or central configuration.

      If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub 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, 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.

      If the service returns an enum value that is not available in the current SDK version, configurationType will return OrganizationConfigurationConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

      Returns:
      Indicates whether the organization uses local or central configuration.

      If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub 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, 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.

      See Also:

    • status

      public final OrganizationConfigurationStatus status()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return OrganizationConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return OrganizationConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.
      See Also:

    • statusMessage

      public final String statusMessage()

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

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

    • toBuilder

      public OrganizationConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OrganizationConfiguration.Builder,OrganizationConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OrganizationConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OrganizationConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.