Class: AWSCDK::ResourceExplorer2::CfnViewProps

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

Overview

Properties for defining a CfnView.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(view_name:, filters: nil, included_properties: nil, scope: nil, tags: nil) ⇒ CfnViewProps

Returns a new instance of CfnViewProps.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'resource_explorer2/cfn_view_props.rb', line 14

def initialize(view_name:, filters: nil, included_properties: nil, scope: nil, tags: nil)
  @view_name = view_name
  Jsii::Type.check_type(@view_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "viewName")
  @filters = filters.is_a?(Hash) ? ::AWSCDK::ResourceExplorer2::CfnView::FiltersProperty.new(**filters.transform_keys(&:to_sym)) : filters
  Jsii::Type.check_type(@filters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZXNvdXJjZWV4cGxvcmVyMi5DZm5WaWV3LkZpbHRlcnNQcm9wZXJ0eSJ9XX19")), "filters") unless @filters.nil?
  @included_properties = included_properties
  Jsii::Type.check_type(@included_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmVzb3VyY2VleHBsb3JlcjIuQ2ZuVmlldy5JbmNsdWRlZFByb3BlcnR5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "includedProperties") unless @included_properties.nil?
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope") unless @scope.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#filters ⇒ AWSCDK::IResolvable, ... (readonly)

An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view.

When you use this view in a Search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer in the AWS Resource Explorer User Guide .

This query string in the context of this operation supports only filter prefixes with optional operators . It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any AWS Region that begin with the letters us and are not tagged with a key Stage that has the value prod .

Returns:

See Also:



42
43
44
 
# File 'resource_explorer2/cfn_view_props.rb', line 42

def filters
  @filters
end

#included_properties ⇒ AWSCDK::IResolvable, ... (readonly)

A list of fields that provide additional information about the view.

Returns:

See Also:



47
48
49
 
# File 'resource_explorer2/cfn_view_props.rb', line 47

def included_properties
  @included_properties
end

#scope ⇒ String? (readonly)

The root ARN of the account, an organizational unit (OU), or an organization ARN.

If left empty, the default is account.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'resource_explorer2/cfn_view_props.rb', line 54

def scope
  @scope
end

#tags ⇒ Hash{String => String}? (readonly)

Tag key and value pairs that are attached to the view.

Returns:

  • (Hash{String => String}, nil)

See Also:



59
60
61
 
# File 'resource_explorer2/cfn_view_props.rb', line 59

def tags
  @tags
end

#view_name ⇒ String (readonly)

The name of the new view.

Returns:

  • (String)

See Also:



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

def view_name
  @view_name
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'resource_explorer2/cfn_view_props.rb', line 61

def self.jsii_properties
  {
    :view_name => "viewName",
    :filters => "filters",
    :included_properties => "includedProperties",
    :scope => "scope",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'resource_explorer2/cfn_view_props.rb', line 71

def to_jsii
  result = {}
  result.merge!({
    "viewName" => @view_name,
    "filters" => @filters,
    "includedProperties" => @included_properties,
    "scope" => @scope,
    "tags" => @tags,
  })
  result.compact
end