Class: Aws::GuardDuty::Types::CreateIPSetRequest

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

Overview

Note:

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

{
  activate: false, # required
  client_token: "__stringMin0Max64",
  detector_id: "__string", # required
  format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE
  location: "Location", # required
  name: "Name", # required
}

Create IP Set Request

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#activate ⇒ Boolean

A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Returns:

  • (Boolean) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  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) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  include Aws::Structure
end

#detector_id ⇒ String

Returns:

  • (String) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  include Aws::Structure
end

#format ⇒ String

The format of the file that contains the IPSet.

Returns:

  • (String) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  include Aws::Structure
end

#location ⇒ String

The URI of the file that contains the IPSet. For example (s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

Returns:

  • (String) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  include Aws::Structure
end

#name ⇒ String

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

Returns:

  • (String) 


464
465
466
467
468
469
470
471
472
 
# File 'lib/aws-sdk-guardduty/types.rb', line 464

class CreateIPSetRequest < Struct.new(
  :activate,
  :client_token,
  :detector_id,
  :format,
  :location,
  :name)
  include Aws::Structure
end