Class: Aws::GuardDuty::Types::CreateDetectorRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Note:

When making an API call, you may pass CreateDetectorRequest data as a hash:

{
  enable: false, # required
  client_token: "ClientToken",
  finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS
  data_sources: {
    s3_logs: {
      enable: false, # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token for the create request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 566

class CreateDetectorRequest < Struct.new(
  :enable,
  :client_token,
  :finding_publishing_frequency,
  :data_sources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_sourcesTypes::DataSourceConfigurations

Describes which data sources will be enabled for the detector.



566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 566

class CreateDetectorRequest < Struct.new(
  :enable,
  :client_token,
  :finding_publishing_frequency,
  :data_sources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enableBoolean

A Boolean value that specifies whether the detector is to be enabled.

Returns:

  • (Boolean)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 566

class CreateDetectorRequest < Struct.new(
  :enable,
  :client_token,
  :finding_publishing_frequency,
  :data_sources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#finding_publishing_frequencyString

A value that specifies how frequently updated findings are exported.

Returns:

  • (String)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 566

class CreateDetectorRequest < Struct.new(
  :enable,
  :client_token,
  :finding_publishing_frequency,
  :data_sources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags to be added to a new detector resource.

Returns:

  • (Hash<String,String>)


566
567
568
569
570
571
572
573
574
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 566

class CreateDetectorRequest < Struct.new(
  :enable,
  :client_token,
  :finding_publishing_frequency,
  :data_sources,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end