AWS::Events::Rule HttpParameters

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "HeaderParameters" : {Key: Value, ...},
  "PathParameterValues" : [ String, ... ],
  "QueryStringParameters" : {Key: Value, ...}
}

YAML

  HeaderParameters: 
    Key: Value
  PathParameterValues: 
    - String
  QueryStringParameters: 
    Key: Value

Properties

HeaderParameters

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

Required: No

Type: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption

PathParameterValues

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

Required: No

Type: Array of String

Update requires: No interruption

QueryStringParameters

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

Required: No

Type: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption