Class: Aws::GuardDuty::Types::CreateThreatEntitySetRequest

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::CreateThreatEntitySetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-guardduty/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #activate ⇒ Boolean

  A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to generate findings.

• #client_token ⇒ String

  The idempotency token for the create request.

• #detector_id ⇒ String

  The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.

• #expected_bucket_owner ⇒ String

  The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

• #format ⇒ String

  The format of the file that contains the threat entity set.

• #location ⇒ String

  The URI of the file that contains the threat entity set.

• #name ⇒ String

  A user-friendly name to identify the threat entity set.

• #tags ⇒ Hash<String,String>

  The tags to be added to a new threat entity set resource.

Instance Attribute Details

#activate ⇒ Boolean

A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to generate findings.

Returns:

• (Boolean)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#detector_id ⇒ String

The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.

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 3262

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

Returns:

• (String)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format of the file that contains the threat entity set.

Returns:

• (String)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ String

The URI of the file that contains the threat entity set. The format of the ‘Location` URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see [Format of location URL under Step 2: Adding trusted or threat intelligence data] in the *Amazon GuardDuty User Guide*.

[1]: docs.aws.amazon.com/guardduty/latest/ug/guardduty-lists-create-activate.html

Returns:

• (String)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A user-friendly name to identify the threat entity set.

The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

Returns:

• (String)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags to be added to a new threat entity set resource.

Returns:

• (Hash<String,String>)

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

class CreateThreatEntitySetRequest < Struct.new(
  :detector_id,
  :name,
  :format,
  :location,
  :expected_bucket_owner,
  :activate,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end