Class: AWSCDK::Glue::CfnCustomEntityTypeProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_custom_entity_type_props.rb

Overview

Properties for defining a CfnCustomEntityType.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context_words: nil, name: nil, regex_string: nil, tags: nil) ⇒ CfnCustomEntityTypeProps

Returns a new instance of CfnCustomEntityTypeProps.

Parameters:

  • context_words (Array<String>, nil) (defaults to: nil) —

    A list of context words.

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

    A name for the custom pattern that allows it to be retrieved or deleted later.

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

    A regular expression string that is used for detecting sensitive data in a custom pattern.

  • tags (Object, nil) (defaults to: nil) —

    AWS tags that contain a key value pair and may be searched by console, command line, or API.



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

def initialize(context_words: nil, name: nil, regex_string: nil, tags: nil)
  @context_words = context_words
  Jsii::Type.check_type(@context_words, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "contextWords") unless @context_words.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @regex_string = regex_string
  Jsii::Type.check_type(@regex_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "regexString") unless @regex_string.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#context_words ⇒ Array<String>? (readonly)

A list of context words.

If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

If no context words are passed only a regular expression is checked.

Returns:

  • (Array<String>, nil)

See Also:



32
33
34
 
# File 'glue/cfn_custom_entity_type_props.rb', line 32

def context_words
  @context_words
end

#name ⇒ String? (readonly)

A name for the custom pattern that allows it to be retrieved or deleted later.

This name must be unique per AWS account.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'glue/cfn_custom_entity_type_props.rb', line 39

def name
  @name
end

#regex_string ⇒ String? (readonly)

A regular expression string that is used for detecting sensitive data in a custom pattern.

Returns:

  • (String, nil)

See Also:



44
45
46
 
# File 'glue/cfn_custom_entity_type_props.rb', line 44

def regex_string
  @regex_string
end

#tags ⇒ Object? (readonly)

AWS tags that contain a key value pair and may be searched by console, command line, or API.

Returns:

  • (Object, nil)

See Also:



49
50
51
 
# File 'glue/cfn_custom_entity_type_props.rb', line 49

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'glue/cfn_custom_entity_type_props.rb', line 51

def self.jsii_properties
  {
    :context_words => "contextWords",
    :name => "name",
    :regex_string => "regexString",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'glue/cfn_custom_entity_type_props.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "contextWords" => @context_words,
    "name" => @name,
    "regexString" => @regex_string,
    "tags" => @tags,
  })
  result.compact
end