Struct AwsApiGatewayMethodSettings

#[non_exhaustive]
pub struct AwsApiGatewayMethodSettings {
    pub metrics_enabled: Option<bool>,
    pub logging_level: Option<String>,
    pub data_trace_enabled: Option<bool>,
    pub throttling_burst_limit: Option<i32>,
    pub throttling_rate_limit: Option<f64>,
    pub caching_enabled: Option<bool>,
    pub cache_ttl_in_seconds: Option<i32>,
    pub cache_data_encrypted: Option<bool>,
    pub require_authorization_for_cache_control: Option<bool>,
    pub unauthorized_cache_control_header_strategy: Option<String>,
    pub http_method: Option<String>,
    pub resource_path: Option<String>,
}

Defines settings for a method for the stage.

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.

metrics_enabled: Option<bool>

Indicates whether CloudWatch metrics are enabled for the method.

logging_level: Option<String>

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

data_trace_enabled: Option<bool>

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

throttling_burst_limit: Option<i32>

The throttling burst limit for the method.

throttling_rate_limit: Option<f64>

The throttling rate limit for the method.

caching_enabled: Option<bool>

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

cache_ttl_in_seconds: Option<i32>

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

cache_data_encrypted: Option<bool>

Indicates whether the cached responses are encrypted.

require_authorization_for_cache_control: Option<bool>

Indicates whether authorization is required for a cache invalidation request.

unauthorized_cache_control_header_strategy: Option<String>

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

http_method: Option<String>

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

resource_path: Option<String>

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

Implementations

impl AwsApiGatewayMethodSettings

pub fn metrics_enabled(&self) -> Option<bool>

Indicates whether CloudWatch metrics are enabled for the method.

pub fn logging_level(&self) -> Option<&str>

The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.

If the logging level is ERROR, then the logs only include error-level entries.

If the logging level is INFO, then the logs include both ERROR events and extra informational events.

Valid values: OFF | ERROR | INFO

pub fn data_trace_enabled(&self) -> Option<bool>

Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

pub fn throttling_burst_limit(&self) -> Option<i32>

The throttling burst limit for the method.

pub fn throttling_rate_limit(&self) -> Option<f64>

The throttling rate limit for the method.

pub fn caching_enabled(&self) -> Option<bool>

Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

pub fn cache_ttl_in_seconds(&self) -> Option<i32>

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

pub fn cache_data_encrypted(&self) -> Option<bool>

Indicates whether the cached responses are encrypted.

pub fn require_authorization_for_cache_control(&self) -> Option<bool>

Indicates whether authorization is required for a cache invalidation request.

pub fn unauthorized_cache_control_header_strategy(&self) -> Option<&str>

Indicates how to handle unauthorized requests for cache invalidation.

Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

pub fn http_method(&self) -> Option<&str>

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

pub fn resource_path(&self) -> Option<&str>

The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.

For example, the path value /resource/subresource must be encoded as /~1resource~1subresource.

To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

impl AwsApiGatewayMethodSettings

pub fn builder() -> AwsApiGatewayMethodSettingsBuilder

Creates a new builder-style object to manufacture AwsApiGatewayMethodSettings.

Trait Implementations

impl Clone for AwsApiGatewayMethodSettings

fn clone(&self) -> AwsApiGatewayMethodSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AwsApiGatewayMethodSettings

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

Formats the value using the given formatter.

impl PartialEq for AwsApiGatewayMethodSettings

fn eq(&self, other: &AwsApiGatewayMethodSettings) -> 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 AwsApiGatewayMethodSettings