Class: Aws::EventBridge::Types::HttpParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

When making an API call, you may pass HttpParameters data as a hash:

{
  path_parameter_values: ["PathParameter"],
  header_parameters: {
    "HeaderKey" => "HeaderValue",
  },
  query_string_parameters: {
    "QueryStringKey" => "QueryStringValue",
  },
}

These are custom parameter to be used when the target is an API Gateway REST 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#header_parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)


2423
2424
2425
2426
2427
2428
2429
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2423

class HttpParameters < Struct.new(
  :path_parameter_values,
  :header_parameters,
  :query_string_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#path_parameter_valuesArray<String>

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

Returns:

  • (Array<String>)


2423
2424
2425
2426
2427
2428
2429
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2423

class HttpParameters < Struct.new(
  :path_parameter_values,
  :header_parameters,
  :query_string_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#query_string_parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)


2423
2424
2425
2426
2427
2428
2429
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2423

class HttpParameters < Struct.new(
  :path_parameter_values,
  :header_parameters,
  :query_string_parameters)
  SENSITIVE = []
  include Aws::Structure
end