AWS::Events::Rule HttpParameters - AWS CloudFormation

AWS::Events::Rule HttpParameters

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

HttpParameters is a property of the Target property type.

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 REST API.

Required: No

Type: Map of String

Update requires: No interruption

PathParameterValues

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

Required: No

Type: List 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 REST API.

Required: No

Type: Map of String

Update requires: No interruption