software.amazon.awssdk.services.guardduty.model

Class OrganizationFeatureConfiguration

java.lang.Object

software.amazon.awssdk.services.guardduty.model.OrganizationFeatureConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrganizationFeatureConfiguration.Builder,OrganizationFeatureConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class OrganizationFeatureConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrganizationFeatureConfiguration.Builder,OrganizationFeatureConfiguration>

A list of features which will be configured for the organization.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OrganizationFeatureConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
List<OrganizationAdditionalConfiguration>	additionalConfiguration() The additional information that will be configured for the organization.
OrgFeatureStatus	autoEnable() Describes the status of the feature that is configured for the member accounts within the organization.
String	autoEnableAsString() Describes the status of the feature that is configured for the member accounts within the organization.
static OrganizationFeatureConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalConfiguration() For responses, this returns true if the service returned a value for the AdditionalConfiguration property.
int	hashCode()
OrgFeature	name() The name of the feature that will be configured for the organization.
String	nameAsString() The name of the feature that will be configured for the organization.
List<SdkField<?>>	sdkFields()
static Class<? extends OrganizationFeatureConfiguration.Builder>	serializableBuilderClass()
OrganizationFeatureConfiguration.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

name

public final OrgFeature name()

The name of the feature that will be configured for the organization.

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

Returns:

The name of the feature that will be configured for the organization.

See Also:

OrgFeature

nameAsString

public final String nameAsString()

The name of the feature that will be configured for the organization.

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

Returns:

The name of the feature that will be configured for the organization.

See Also:

OrgFeature

autoEnable

public final OrgFeatureStatus autoEnable()

Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

• NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

• ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

• NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.

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

Returns:

Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

• NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

• ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

• NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.

See Also:

OrgFeatureStatus

autoEnableAsString

public final String autoEnableAsString()

Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

• NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

• ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

• NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.

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

Returns:

Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

• NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

• ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

• NONE: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.

See Also:

OrgFeatureStatus

hasAdditionalConfiguration

public final boolean hasAdditionalConfiguration()

For responses, this returns true if the service returned a value for the AdditionalConfiguration property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

additionalConfiguration

public final List<OrganizationAdditionalConfiguration> additionalConfiguration()

The additional information that will be configured for the organization.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalConfiguration() method.

Returns:

The additional information that will be configured for the organization.

toBuilder

public OrganizationFeatureConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OrganizationFeatureConfiguration.Builder,OrganizationFeatureConfiguration>

builder

public static OrganizationFeatureConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends OrganizationFeatureConfiguration.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