interface HttpParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Events.CfnRule.HttpParametersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnRule_HttpParametersProperty`
Java	`software.amazon.awscdk.services.events.CfnRule.HttpParametersProperty`
Python	`aws_cdk.aws_events.CfnRule.HttpParametersProperty`
TypeScript	`aws-cdk-lib` » `aws_events` » `CfnRule` » `HttpParametersProperty`

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const httpParametersProperty: events.CfnRule.HttpParametersProperty = {
  headerParameters: {
    headerParametersKey: 'headerParameters',
  },
  pathParameterValues: ['pathParameterValues'],
  queryStringParameters: {
    queryStringParametersKey: 'queryStringParameters',
  },
};

Properties

Name	Type	Description
headerParameters?	`{ [string]: string } \|` `IResolvable`	The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
pathParameterValues?	`string[]`	The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
queryStringParameters?	`{ [string]: string } \|` `IResolvable`	The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

headerParameters?

Type: { [string]: string } | IResolvable (optional)

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

pathParameterValues?

Type: string[] (optional)

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

queryStringParameters?

Type: { [string]: string } | IResolvable (optional)

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