Struct aws_sdk_wafv2::types::CustomResponse
source · #[non_exhaustive]pub struct CustomResponse {
pub response_code: i32,
pub custom_response_body_key: Option<String>,
pub response_headers: Option<Vec<CustomHttpHeader>>,
}
Expand description
A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction
.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.response_code: i32
The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
custom_response_body_key: Option<String>
References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies
setting for the WebACL
or RuleGroup
where you want to use it. Then, in the rule action or web ACL default action BlockAction
setting, you reference the response body using this key.
response_headers: Option<Vec<CustomHttpHeader>>
The HTTP headers to use in the response. You can specify any header name except for content-type
. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
Implementations§
source§impl CustomResponse
impl CustomResponse
sourcepub fn response_code(&self) -> i32
pub fn response_code(&self) -> i32
The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
sourcepub fn custom_response_body_key(&self) -> Option<&str>
pub fn custom_response_body_key(&self) -> Option<&str>
References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies
setting for the WebACL
or RuleGroup
where you want to use it. Then, in the rule action or web ACL default action BlockAction
setting, you reference the response body using this key.
sourcepub fn response_headers(&self) -> &[CustomHttpHeader]
pub fn response_headers(&self) -> &[CustomHttpHeader]
The HTTP headers to use in the response. You can specify any header name except for content-type
. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .response_headers.is_none()
.
source§impl CustomResponse
impl CustomResponse
sourcepub fn builder() -> CustomResponseBuilder
pub fn builder() -> CustomResponseBuilder
Creates a new builder-style object to manufacture CustomResponse
.
Trait Implementations§
source§impl Clone for CustomResponse
impl Clone for CustomResponse
source§fn clone(&self) -> CustomResponse
fn clone(&self) -> CustomResponse
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CustomResponse
impl Debug for CustomResponse
source§impl PartialEq for CustomResponse
impl PartialEq for CustomResponse
source§fn eq(&self, other: &CustomResponse) -> bool
fn eq(&self, other: &CustomResponse) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CustomResponse
Auto Trait Implementations§
impl Freeze for CustomResponse
impl RefUnwindSafe for CustomResponse
impl Send for CustomResponse
impl Sync for CustomResponse
impl Unpin for CustomResponse
impl UnwindSafe for CustomResponse
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more