Class: AWSCDK::GuardDuty::CfnThreatEntitySetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
guard_duty/cfn_threat_entity_set_props.rb

Overview

Properties for defining a CfnThreatEntitySet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(format:, location:, activate: nil, detector_id: nil, expected_bucket_owner: nil, name: nil, tags: nil) ⇒ CfnThreatEntitySetProps

Returns a new instance of CfnThreatEntitySetProps.

Parameters:

  • 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.

  • activate (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A boolean value that determines if GuardDuty can start using this list for custom threat detection.

  • detector_id (String, nil) (defaults to: nil) —

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

  • expected_bucket_owner (String, nil) (defaults to: nil) —

    The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

  • name (String, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::GuardDuty::CfnThreatEntitySet::TagItemProperty>, nil) (defaults to: nil) —

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 16

def initialize(format:, location:, activate: nil, detector_id: nil, expected_bucket_owner: nil, name: nil, tags: nil)
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  @location = location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "location")
  @activate = activate
  Jsii::Type.check_type(@activate, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "activate") unless @activate.nil?
  @detector_id = detector_id
  Jsii::Type.check_type(@detector_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "detectorId") unless @detector_id.nil?
  @expected_bucket_owner = expected_bucket_owner
  Jsii::Type.check_type(@expected_bucket_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expectedBucketOwner") unless @expected_bucket_owner.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::GuardDuty::CfnThreatEntitySet::TagItemProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ndWFyZGR1dHkuQ2ZuVGhyZWF0RW50aXR5U2V0LlRhZ0l0ZW1Qcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#activate ⇒ Boolean, ... (readonly)

A boolean value that determines if GuardDuty can start using this list for custom threat detection.

For GuardDuty to consider the entries in this list and generate findings based on associated activity, this list must be active.

Returns:

See Also:



51
52
53
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 51

def activate
  @activate
end

#detector_id ⇒ String? (readonly)

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

To find the detector_id in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 58

def detector_id
  @detector_id
end

#expected_bucket_owner ⇒ String? (readonly)

The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

Whether or not you provide the account ID for this optional field, GuardDuty validates that the account ID associated with the DetectorId owns the S3 bucket in the Location field. If GuardDuty finds that this S3 bucket doesn't belong to the specified account ID, you will get an error at the time of activating this list.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 65

def expected_bucket_owner
  @expected_bucket_owner
end

#format ⇒ String (readonly)

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

For information about supported formats, see List formats in the Amazon GuardDuty User Guide .

Returns:

  • (String)

See Also:



39
40
41
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 39

def format
  @format
end

#location ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



44
45
46
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 44

def location
  @location
end

#name ⇒ String? (readonly)

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

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

Returns:

  • (String, nil)

See Also:



72
73
74
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 72

def name
  @name
end

#tags ⇒ Array<AWSCDK::GuardDuty::CfnThreatEntitySet::TagItemProperty>? (readonly)

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

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .

Returns:

See Also:



81
82
83
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 81

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 83

def self.jsii_properties
  {
    :format => "format",
    :location => "location",
    :activate => "activate",
    :detector_id => "detectorId",
    :expected_bucket_owner => "expectedBucketOwner",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'guard_duty/cfn_threat_entity_set_props.rb', line 95

def to_jsii
  result = {}
  result.merge!({
    "format" => @format,
    "location" => @location,
    "activate" => @activate,
    "detectorId" => @detector_id,
    "expectedBucketOwner" => @expected_bucket_owner,
    "name" => @name,
    "tags" => @tags,
  })
  result.compact
end