Class: AWSCDK::Events::CfnRule::HttpParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
events/cfn_rule.rb

Overview

These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations.

In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(header_parameters: nil, path_parameter_values: nil, query_string_parameters: nil) ⇒ HttpParametersProperty

Returns a new instance of HttpParametersProperty.

Parameters:

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

    The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

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

    The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").

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

    The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.



1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'events/cfn_rule.rb', line 1182

def initialize(header_parameters: nil, path_parameter_values: nil, query_string_parameters: nil)
  @header_parameters = header_parameters
  Jsii::Type.check_type(@header_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "headerParameters") unless @header_parameters.nil?
  @path_parameter_values = path_parameter_values
  Jsii::Type.check_type(@path_parameter_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "pathParameterValues") unless @path_parameter_values.nil?
  @query_string_parameters = query_string_parameters
  Jsii::Type.check_type(@query_string_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "queryStringParameters") unless @query_string_parameters.nil?
end

Instance Attribute Details

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

The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

Returns:

See Also:



1195
1196
1197
 
# File 'events/cfn_rule.rb', line 1195

def header_parameters
  @header_parameters
end

#path_parameter_values ⇒ Array<String>? (readonly)

The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").

Returns:

  • (Array<String>, nil)

See Also:



1200
1201
1202
 
# File 'events/cfn_rule.rb', line 1200

def path_parameter_values
  @path_parameter_values
end

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

The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

Returns:

See Also:



1205
1206
1207
 
# File 'events/cfn_rule.rb', line 1205

def query_string_parameters
  @query_string_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



1207
1208
1209
1210
1211
1212
1213
 
# File 'events/cfn_rule.rb', line 1207

def self.jsii_properties
  {
    :header_parameters => "headerParameters",
    :path_parameter_values => "pathParameterValues",
    :query_string_parameters => "queryStringParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'events/cfn_rule.rb', line 1215

def to_jsii
  result = {}
  result.merge!({
    "headerParameters" => @header_parameters,
    "pathParameterValues" => @path_parameter_values,
    "queryStringParameters" => @query_string_parameters,
  })
  result.compact
end