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

Inherits:

Struct

• Object
• Struct
• Aws::GuardDuty::Types::CreateIPSetRequest

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 is to start using the uploaded IPSet.

• #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 an IPSet.

• #format ⇒ String

  The format of the file that contains the IPSet.

• #location ⇒ String

  The URI of the file that contains the IPSet.

• #name ⇒ String

  The user-friendly name to identify the IPSet.

• #tags ⇒ Hash<String,String>

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

Instance Attribute Details

#activate ⇒ Boolean

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

Returns:

• (Boolean)

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

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

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

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 1560

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

#format ⇒ String

The format of the file that contains the IPSet.

Returns:

• (String)

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

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

#location ⇒ String

The URI of the file that contains the IPSet.

Returns:

• (String)

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

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

#name ⇒ String

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

Returns:

• (String)

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

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

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

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