This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Events::Rule HttpParameters
<a name="aws-properties-events-rule-httpparameters"></a>

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
<a name="aws-properties-events-rule-httpparameters-syntax"></a>

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

### JSON
<a name="aws-properties-events-rule-httpparameters-syntax.json"></a>

```
{
  "[HeaderParameters](#cfn-events-rule-httpparameters-headerparameters)" : {{{{{Key}}: {{Value}}, ...}}},
  "[PathParameterValues](#cfn-events-rule-httpparameters-pathparametervalues)" : {{[ String, ... ]}},
  "[QueryStringParameters](#cfn-events-rule-httpparameters-querystringparameters)" : {{{{{Key}}: {{Value}}, ...}}}
}
```

### YAML
<a name="aws-properties-events-rule-httpparameters-syntax.yaml"></a>

```
  [HeaderParameters](#cfn-events-rule-httpparameters-headerparameters): {{
    {{Key}}: {{Value}}}}
  [PathParameterValues](#cfn-events-rule-httpparameters-pathparametervalues): {{
    - String}}
  [QueryStringParameters](#cfn-events-rule-httpparameters-querystringparameters): {{
    {{Key}}: {{Value}}}}
```

## Properties
<a name="aws-properties-events-rule-httpparameters-properties"></a>

`HeaderParameters`  <a name="cfn-events-rule-httpparameters-headerparameters"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PathParameterValues`  <a name="cfn-events-rule-httpparameters-pathparametervalues"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringParameters`  <a name="cfn-events-rule-httpparameters-querystringparameters"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)