Class: AWSCDK::ResourceExplorer2::CfnIndexProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
resource_explorer2/cfn_index_props.rb

Overview

Properties for defining a CfnIndex.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, tags: nil) ⇒ CfnIndexProps

Returns a new instance of CfnIndexProps.

Parameters:

  • type (String)

    Specifies the type of the index in this Region.

  • tags (Hash{String => String}, nil) (defaults to: nil)

    The specified tags are attached to only the index created in this AWS Region .



11
12
13
14
15
16
# File 'resource_explorer2/cfn_index_props.rb', line 11

def initialize(type:, tags: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#tagsHash{String => String}? (readonly)

The specified tags are attached to only the index created in this AWS Region .

The tags don't attach to any of the resources listed in the index.



31
32
33
# File 'resource_explorer2/cfn_index_props.rb', line 31

def tags
  @tags
end

#typeString (readonly)

Specifies the type of the index in this Region.

For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index in the AWS Resource Explorer User Guide. .



24
25
26
# File 'resource_explorer2/cfn_index_props.rb', line 24

def type
  @type
end

Class Method Details

.jsii_propertiesObject



33
34
35
36
37
38
# File 'resource_explorer2/cfn_index_props.rb', line 33

def self.jsii_properties
  {
    :type => "type",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



40
41
42
43
44
45
46
47
# File 'resource_explorer2/cfn_index_props.rb', line 40

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