Struct HttpParameters

#[non_exhaustive]
pub struct HttpParameters {
    pub path_parameter_values: Option<Vec<String>>,
    pub header_parameters: Option<HashMap<String, String>>,
    pub query_string_parameters: Option<HashMap<String, String>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path_parameter_values: Option<Vec<String>>

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

header_parameters: Option<HashMap<String, String>>

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

query_string_parameters: Option<HashMap<String, String>>

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

Implementations

impl HttpParameters

pub fn path_parameter_values(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .path_parameter_values.is_none().

pub fn header_parameters(&self) -> Option<&HashMap<String, String>>

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

pub fn query_string_parameters(&self) -> Option<&HashMap<String, String>>

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

impl HttpParameters

pub fn builder() -> HttpParametersBuilder

Creates a new builder-style object to manufacture HttpParameters.

Trait Implementations

impl Clone for HttpParameters

fn clone(&self) -> HttpParameters

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HttpParameters

fn eq(&self, other: &HttpParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpParameters