Class: AWSCDK::Macie::CfnAllowListProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
macie/cfn_allow_list_props.rb

Overview

Properties for defining a CfnAllowList.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(criteria:, name:, description: nil, tags: nil) ⇒ CfnAllowListProps

Returns a new instance of CfnAllowListProps.

Parameters:

  • criteria (AWSCDK::IResolvable, AWSCDK::Macie::CfnAllowList::CriteriaProperty) —

    The criteria that specify the text or text pattern to ignore.

  • name (String) —

    A custom name for the allow list.

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

    A custom description of the allow list.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to the allow list.



13
14
15
16
17
18
19
20
21
22
 
# File 'macie/cfn_allow_list_props.rb', line 13

def initialize(criteria:, name:, description: nil, tags: nil)
  @criteria = criteria.is_a?(Hash) ? ::AWSCDK::Macie::CfnAllowList::CriteriaProperty.new(**criteria.transform_keys(&:to_sym)) : criteria
  Jsii::Type.check_type(@criteria, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tYWNpZS5DZm5BbGxvd0xpc3QuQ3JpdGVyaWFQcm9wZXJ0eSJ9XX19")), "criteria")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#criteria ⇒ AWSCDK::IResolvable, AWSCDK::Macie::CfnAllowList::CriteriaProperty (readonly)

The criteria that specify the text or text pattern to ignore.

The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( S3WordsList ), or a regular expression ( Regex ) that defines a text pattern to ignore.

Returns:

See Also:



30
31
32
 
# File 'macie/cfn_allow_list_props.rb', line 30

def criteria
  @criteria
end

#description ⇒ String? (readonly)

A custom description of the allow list.

The description can contain 1-512 characters.

Returns:

  • (String, nil)

See Also:



44
45
46
 
# File 'macie/cfn_allow_list_props.rb', line 44

def description
  @description
end

#name ⇒ String (readonly)

A custom name for the allow list.

The name can contain 1-128 characters.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'macie/cfn_allow_list_props.rb', line 37

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to the allow list.

For more information, see Resource tag .

Returns:

See Also:



51
52
53
 
# File 'macie/cfn_allow_list_props.rb', line 51

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'macie/cfn_allow_list_props.rb', line 53

def self.jsii_properties
  {
    :criteria => "criteria",
    :name => "name",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'macie/cfn_allow_list_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "criteria" => @criteria,
    "name" => @name,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end