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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrganizationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static OrganizationConfiguration.Builder	builder()
OrganizationConfigurationConfigurationType	configurationType()	Indicates whether the organization uses local or central configuration.
String	configurationTypeAsString()	Indicates whether the organization uses local or central configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationConfiguration.Builder>	serializableBuilderClass()
OrganizationConfigurationStatus	status()	Describes whether central configuration could be enabled as the ConfigurationType for the organization.
String	statusAsString()	Describes whether central configuration could be enabled as the ConfigurationType for the organization.
String	statusMessage()	Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
OrganizationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

OrganizationConfigurationConfigurationType

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:

OrganizationConfigurationConfigurationType

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:

OrganizationConfigurationStatus

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:

OrganizationConfigurationStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<OrganizationConfiguration.Builder,OrganizationConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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