You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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 CreateIPSetRequest data as a hash:

{
  detector_id: "DetectorId", # required
  name: "Name", # required
  format: "TXT", # required, accepts TXT, STIX, OTX_CSV, ALIEN_VAULT, PROOF_POINT, FIRE_EYE
  location: "Location", # required
  activate: false, # required
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#activateBoolean

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

Returns:

  • (Boolean)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#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)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#detector_idString

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

Returns:

  • (String)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#formatString

The format of the file that contains the IPSet.

Returns:

  • (String)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#locationString

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

Returns:

  • (String)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#nameString

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)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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

#tagsHash<String,String>

The tags to be added to a new IP set resource.

Returns:

  • (Hash<String,String>)


551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 551

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