Class: AWSCDK::LakeFormation::CfnTagProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lake_formation/cfn_tag_props.rb

Overview

Properties for defining a CfnTag.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tag_key:, tag_values:, catalog_id: nil) ⇒ CfnTagProps

Returns a new instance of CfnTagProps.

Parameters:

  • tag_key (String) —

    UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

  • tag_values (Array<String>) —

    An array of UTF-8 strings, not less than 1 or more than 50 strings.

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

    Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .



12
13
14
15
16
17
18
19
 
# File 'lake_formation/cfn_tag_props.rb', line 12

def initialize(tag_key:, tag_values:, catalog_id: nil)
  @tag_key = tag_key
  Jsii::Type.check_type(@tag_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tagKey")
  @tag_values = tag_values
  Jsii::Type.check_type(@tag_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagValues")
  @catalog_id = catalog_id
  Jsii::Type.check_type(@catalog_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalogId") unless @catalog_id.nil?
end

Instance Attribute Details

#catalog_id ⇒ String? (readonly)

Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

The identifier for the Data Catalog . By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 'lake_formation/cfn_tag_props.rb', line 41

def catalog_id
  @catalog_id
end

#tag_key ⇒ String (readonly)

UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

The key-name for the LF-tag.

Returns:

  • (String)

See Also:



27
28
29
 
# File 'lake_formation/cfn_tag_props.rb', line 27

def tag_key
  @tag_key
end

#tag_values ⇒ Array<String> (readonly)

An array of UTF-8 strings, not less than 1 or more than 50 strings.

A list of possible values of the corresponding TagKey of an LF-tag key-value pair.

Returns:

  • (Array<String>)

See Also:



34
35
36
 
# File 'lake_formation/cfn_tag_props.rb', line 34

def tag_values
  @tag_values
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lake_formation/cfn_tag_props.rb', line 43

def self.jsii_properties
  {
    :tag_key => "tagKey",
    :tag_values => "tagValues",
    :catalog_id => "catalogId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'lake_formation/cfn_tag_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "tagKey" => @tag_key,
    "tagValues" => @tag_values,
    "catalogId" => @catalog_id,
  })
  result.compact
end