Package software.amazon.awssdk.services.guardduty.model

Class UpdateOrganizationConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.guardduty.model.GuardDutyRequest
software.amazon.awssdk.services.guardduty.model.UpdateOrganizationConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateOrganizationConfigurationRequest.Builder,UpdateOrganizationConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateOrganizationConfigurationRequest extends GuardDutyRequest implements ToCopyableBuilder<UpdateOrganizationConfigurationRequest.Builder,UpdateOrganizationConfigurationRequest>

  • Method Details

    • detectorId

      public final String detectorId()

      The ID of the detector that configures the delegated administrator.

      Returns:
      The ID of the detector that configures the delegated administrator.

    • autoEnable

      @Deprecated public final Boolean autoEnable()
      Deprecated.
      This field is deprecated, use AutoEnableOrganizationMembers instead

      Represents whether or not to automatically enable member accounts in the organization.

      Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

      Returns:
      Represents whether or not to automatically enable member accounts in the organization.

      Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

    • dataSources

      @Deprecated public final OrganizationDataSourceConfigurations dataSources()
      Deprecated.
      This parameter is deprecated, use Features instead

      Describes which data sources will be updated.

      Returns:
      Describes which data sources will be updated.

    • hasFeatures

      public final boolean hasFeatures()
      For responses, this returns true if the service returned a value for the Features 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.

    • features

      public final List<OrganizationFeatureConfiguration> features()

      A list of features 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 hasFeatures() method.

      Returns:
      A list of features that will be configured for the organization.

    • autoEnableOrganizationMembers

      public final AutoEnableMembers autoEnableOrganizationMembers()

      Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

      Use one of the following configuration values for autoEnableOrganizationMembers:

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

      • ALL: Indicates that all accounts in the organization have GuardDuty 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 GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

        When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

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

      Returns:
      Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

      Use one of the following configuration values for autoEnableOrganizationMembers:

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

      • ALL: Indicates that all accounts in the organization have GuardDuty 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 GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

        When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

      See Also:

    • autoEnableOrganizationMembersAsString

      public final String autoEnableOrganizationMembersAsString()

      Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

      Use one of the following configuration values for autoEnableOrganizationMembers:

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

      • ALL: Indicates that all accounts in the organization have GuardDuty 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 GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

        When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

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

      Returns:
      Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

      Use one of the following configuration values for autoEnableOrganizationMembers:

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

      • ALL: Indicates that all accounts in the organization have GuardDuty 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 GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

        When you update the auto-enable setting from ALL or NEW to NONE, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

      See Also:

    • toBuilder

      public UpdateOrganizationConfigurationRequest.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<UpdateOrganizationConfigurationRequest.Builder,UpdateOrganizationConfigurationRequest>
      Specified by:
      toBuilder in class GuardDutyRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateOrganizationConfigurationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.