Class: AWSCDK::CloudTrail::CfnDashboard::WidgetProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_trail/cfn_dashboard.rb

Overview

Contains information about a widget on a CloudTrail Lake dashboard.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query_statement:, query_parameters: nil, view_properties: nil) ⇒ WidgetProperty

Returns a new instance of WidgetProperty.

Parameters:

  • query_statement (String) —

    The query statement for the widget.

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

    The optional query parameters.

  • view_properties (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

    The view properties for the widget.



729
730
731
732
733
734
735
736
 
# File 'cloud_trail/cfn_dashboard.rb', line 729

def initialize(query_statement:, query_parameters: nil, view_properties: nil)
  @query_statement = query_statement
  Jsii::Type.check_type(@query_statement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryStatement")
  @query_parameters = query_parameters
  Jsii::Type.check_type(@query_parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "queryParameters") unless @query_parameters.nil?
  @view_properties = view_properties
  Jsii::Type.check_type(@view_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "viewProperties") unless @view_properties.nil?
end

Instance Attribute Details

#query_parameters ⇒ Array<String>? (readonly)

The optional query parameters.

The following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

Returns:

  • (Array<String>, nil)

See Also:



753
754
755
 
# File 'cloud_trail/cfn_dashboard.rb', line 753

def query_parameters
  @query_parameters
end

#query_statement ⇒ String (readonly)

The query statement for the widget.

For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

When a query uses ? with event_time , ? must be surrounded by single quotes as follows: '?' .

Returns:

  • (String)

See Also:



746
747
748
 
# File 'cloud_trail/cfn_dashboard.rb', line 746

def query_statement
  @query_statement
end

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

The view properties for the widget.

For more information about view properties, see View properties for widgets in the AWS CloudTrail User Guide .

Returns:

See Also:



760
761
762
 
# File 'cloud_trail/cfn_dashboard.rb', line 760

def view_properties
  @view_properties
end

Class Method Details

.jsii_properties ⇒ Object 



762
763
764
765
766
767
768
 
# File 'cloud_trail/cfn_dashboard.rb', line 762

def self.jsii_properties
  {
    :query_statement => "queryStatement",
    :query_parameters => "queryParameters",
    :view_properties => "viewProperties",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



770
771
772
773
774
775
776
777
778
 
# File 'cloud_trail/cfn_dashboard.rb', line 770

def to_jsii
  result = {}
  result.merge!({
    "queryStatement" => @query_statement,
    "queryParameters" => @query_parameters,
    "viewProperties" => @view_properties,
  })
  result.compact
end