Class: AWSCDK::Athena::CfnPreparedStatementProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
athena/cfn_prepared_statement_props.rb

Overview

Properties for defining a CfnPreparedStatement.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query_statement:, statement_name:, work_group:, description: nil) ⇒ CfnPreparedStatementProps

Returns a new instance of CfnPreparedStatementProps.

Parameters:

  • query_statement (String) —

    The query string for the prepared statement.

  • statement_name (String) —

    The name of the prepared statement.

  • work_group (String, AWSCDK::Interfaces::AWSAthena::IWorkGroupRef) —

    The workgroup to which the prepared statement belongs.

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

    The description of the prepared statement.



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

def initialize(query_statement:, statement_name:, work_group:, description: nil)
  @query_statement = query_statement
  Jsii::Type.check_type(@query_statement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryStatement")
  @statement_name = statement_name
  Jsii::Type.check_type(@statement_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statementName")
  @work_group = work_group
  Jsii::Type.check_type(@work_group, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hdGhlbmEuSVdvcmtHcm91cFJlZiJ9XX19")), "workGroup")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the prepared statement.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'athena/cfn_prepared_statement_props.rb', line 43

def description
  @description
end

#query_statement ⇒ String (readonly)

The query string for the prepared statement.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'athena/cfn_prepared_statement_props.rb', line 28

def query_statement
  @query_statement
end

#statement_name ⇒ String (readonly)

The name of the prepared statement.

Returns:

  • (String)

See Also:



33
34
35
 
# File 'athena/cfn_prepared_statement_props.rb', line 33

def statement_name
  @statement_name
end

#work_group ⇒ String, AWSCDK::Interfaces::AWSAthena::IWorkGroupRef (readonly)

The workgroup to which the prepared statement belongs.

Returns:

See Also:



38
39
40
 
# File 'athena/cfn_prepared_statement_props.rb', line 38

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'athena/cfn_prepared_statement_props.rb', line 45

def self.jsii_properties
  {
    :query_statement => "queryStatement",
    :statement_name => "statementName",
    :work_group => "workGroup",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'athena/cfn_prepared_statement_props.rb', line 54

def to_jsii
  result = {}
  result.merge!({
    "queryStatement" => @query_statement,
    "statementName" => @statement_name,
    "workGroup" => @work_group,
    "description" => @description,
  })
  result.compact
end