Package software.amazon.awscdk.services.events

Interface CfnRule.HttpParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.HttpParametersProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(Stable)
public static interface CfnRule.HttpParametersProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.events.*;
 HttpParametersProperty httpParametersProperty = HttpParametersProperty.builder()
         .headerParameters(Map.of(
                 "headerParametersKey", "headerParameters"))
         .pathParameterValues(List.of("pathParameterValues"))
         .queryStringParameters(Map.of(
                 "queryStringParametersKey", "queryStringParameters"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRule.HttpParametersProperty.Builder	A builder for CfnRule.HttpParametersProperty
static final class	CfnRule.HttpParametersProperty.Jsii$Proxy	An implementation for CfnRule.HttpParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnRule.HttpParametersProperty.Builder	builder()
default Object	getHeaderParameters()	The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
default List<String>	getPathParameterValues()	The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").
default Object	getQueryStringParameters()	The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeaderParameters

@Stability(Stable)
@Nullable
default Object getHeaderParameters()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-headerparameters

getPathParameterValues

@Stability(Stable)
@Nullable
default List<String> getPathParameterValues()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-pathparametervalues

getQueryStringParameters

@Stability(Stable)
@Nullable
default Object getQueryStringParameters()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-httpparameters.html#cfn-events-rule-httpparameters-querystringparameters

builder

@Stability(Stable)
static CfnRule.HttpParametersProperty.Builder builder()

Returns:

a CfnRule.HttpParametersProperty.Builder of CfnRule.HttpParametersProperty