Struct CustomResponseBuilder

#[non_exhaustive]
pub struct CustomResponseBuilder { /* private fields */ }

A builder for CustomResponse.

Implementations

impl CustomResponseBuilder

pub fn response_code(self, input: i32) -> Self

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.

This field is required.

pub fn set_response_code(self, input: Option<i32>) -> Self

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.

pub fn get_response_code(&self) -> &Option<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.

pub fn custom_response_body_key(self, input: impl Into<String>) -> Self

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.

pub fn set_custom_response_body_key(self, input: Option<String>) -> Self

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.

pub fn get_custom_response_body_key(&self) -> &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.

pub fn response_headers(self, input: CustomHttpHeader) -> Self

Appends an item to response_headers.

To override the contents of this collection use set_response_headers.

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.

pub fn set_response_headers(self, input: Option<Vec<CustomHttpHeader>>) -> Self

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.

pub fn get_response_headers(&self) -> &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.

pub fn build(self) -> Result<CustomResponse, BuildError>

Consumes the builder and constructs a CustomResponse. This method will fail if any of the following fields are not set:

• response_code

Trait Implementations

impl Clone for CustomResponseBuilder

fn clone(&self) -> CustomResponseBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomResponseBuilder

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

Formats the value using the given formatter.

impl Default for CustomResponseBuilder

fn default() -> CustomResponseBuilder

Returns the “default value” for a type.

impl PartialEq for CustomResponseBuilder

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

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

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 CustomResponseBuilder