Class: Aws::GuardDuty::Types::DetectionRuleOrgConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::DetectionRuleOrgConfiguration

Defined in:

gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Contains the organization-level configuration for a custom detection rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The timestamp when the organization configuration was created.

• #exclude_account_ids ⇒ Array<String>

  A list of member account IDs excluded from the organization configuration.

• #expires_at ⇒ Time

  The timestamp when the organization configuration expires.

• #include_account_ids ⇒ Array<String>

  A list of member account IDs included in the organization configuration.

• #mode ⇒ String

  The execution mode of the organization configuration.

• #rule_id ⇒ String

  The unique identifier for the custom detection rule.

• #status ⇒ String

  The configuration status.

• #status_reason ⇒ String

  The reason for the current configuration status.

• #updated_at ⇒ Time

  The timestamp when the organization configuration was last updated.

Instance Attribute Details

#created_at ⇒ Time

The timestamp when the organization configuration was created.

Returns:

• (Time)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_account_ids ⇒ Array<String>

A list of member account IDs excluded from the organization configuration. Mutually exclusive with IncludeAccountIds.

Returns:

• (Array<String>)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#expires_at ⇒ Time

The timestamp when the organization configuration expires.

Returns:

• (Time)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#include_account_ids ⇒ Array<String>

A list of member account IDs included in the organization configuration. Mutually exclusive with ExcludeAccountIds.

Returns:

• (Array<String>)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

The execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.

Returns:

• (String)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

The unique identifier for the custom detection rule.

Returns:

• (String)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The configuration status. Valid values: ACTIVE | PROCESSING | FAILED.

Returns:

• (String)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason for the current configuration status.

Returns:

• (String)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the organization configuration was last updated.

Returns:

• (Time)

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

class DetectionRuleOrgConfiguration < Struct.new(
  :rule_id,
  :mode,
  :status,
  :status_reason,
  :include_account_ids,
  :exclude_account_ids,
  :created_at,
  :updated_at,
  :expires_at)
  SENSITIVE = []
  include Aws::Structure
end