Class: Aws::GuardDuty::Types::UpdateOrganizationConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::UpdateOrganizationConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-guardduty/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_enable ⇒ Boolean

  Represents whether to automatically enable member accounts in the organization.

• #auto_enable_organization_members ⇒ String

  Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization.

• #data_sources ⇒ Types::OrganizationDataSourceConfigurations

  Describes which data sources will be updated.

• #detector_id ⇒ String

  The ID of the detector that configures the delegated administrator.

• #features ⇒ Array<Types::OrganizationFeatureConfiguration>

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

Instance Attribute Details

#auto_enable ⇒ Boolean

Represents whether to automatically enable member accounts in the organization. This applies to only new member accounts, not the existing member accounts. When a new account joins the organization, the chosen features will be enabled for them by default.

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:

• (Boolean)

# File 'lib/aws-sdk-guardduty/types.rb', line 9727

class UpdateOrganizationConfigurationRequest < Struct.new(
  :detector_id,
  :auto_enable,
  :data_sources,
  :features,
  :auto_enable_organization_members)
  SENSITIVE = []
  include Aws::Structure
end

#auto_enable_organization_members ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-guardduty/types.rb', line 9727

class UpdateOrganizationConfigurationRequest < Struct.new(
  :detector_id,
  :auto_enable,
  :data_sources,
  :features,
  :auto_enable_organization_members)
  SENSITIVE = []
  include Aws::Structure
end

#data_sources ⇒ Types::OrganizationDataSourceConfigurations

Describes which data sources will be updated.

Returns:

• (Types::OrganizationDataSourceConfigurations)

# File 'lib/aws-sdk-guardduty/types.rb', line 9727

class UpdateOrganizationConfigurationRequest < Struct.new(
  :detector_id,
  :auto_enable,
  :data_sources,
  :features,
  :auto_enable_organization_members)
  SENSITIVE = []
  include Aws::Structure
end

#detector_id ⇒ String

The ID of the detector that configures the delegated administrator.

To find the ‘detectorId` in the current Region, see the Settings page in the GuardDuty console, or run the [ListDetectors] API.

[1]: docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html

Returns:

• (String)

# File 'lib/aws-sdk-guardduty/types.rb', line 9727

class UpdateOrganizationConfigurationRequest < Struct.new(
  :detector_id,
  :auto_enable,
  :data_sources,
  :features,
  :auto_enable_organization_members)
  SENSITIVE = []
  include Aws::Structure
end

#features ⇒ Array<Types::OrganizationFeatureConfiguration>

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

Returns:

• (Array<Types::OrganizationFeatureConfiguration>)

# File 'lib/aws-sdk-guardduty/types.rb', line 9727

class UpdateOrganizationConfigurationRequest < Struct.new(
  :detector_id,
  :auto_enable,
  :data_sources,
  :features,
  :auto_enable_organization_members)
  SENSITIVE = []
  include Aws::Structure
end