Struct aws_sdk_appsync::operation::update_api_cache::UpdateApiCacheInput

#[non_exhaustive]
pub struct UpdateApiCacheInput {
    pub api_id: Option<String>,
    pub ttl: Option<i64>,
    pub api_caching_behavior: Option<ApiCachingBehavior>,
    pub type: Option<ApiCacheType>,
    pub health_metrics_config: Option<CacheHealthMetricsConfig>,
}

Represents the input of a UpdateApiCache operation.

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.

api_id: Option<String>

The GraphQL API ID.

ttl: Option<i64>

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

api_caching_behavior: Option<ApiCachingBehavior>

Caching behavior.

• FULL_REQUEST_CACHING: All requests are fully cached.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

type: Option<ApiCacheType>

The cache instance type. Valid values are

• SMALL

• MEDIUM

• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X

• LARGE_8X (not available in all regions)

• LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

• T2_SMALL: A t2.small instance type.

• T2_MEDIUM: A t2.medium instance type.

• R4_LARGE: A r4.large instance type.

• R4_XLARGE: A r4.xlarge instance type.

• R4_2XLARGE: A r4.2xlarge instance type.

• R4_4XLARGE: A r4.4xlarge instance type.

• R4_8XLARGE: A r4.8xlarge instance type.

health_metrics_config: Option<CacheHealthMetricsConfig>

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

• NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.

• EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

Implementations

impl UpdateApiCacheInput

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

The GraphQL API ID.

pub fn ttl(&self) -> Option<i64>

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

pub fn api_caching_behavior(&self) -> Option<&ApiCachingBehavior>

Caching behavior.

• FULL_REQUEST_CACHING: All requests are fully cached.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

pub fn type(&self) -> Option<&ApiCacheType>

The cache instance type. Valid values are

• SMALL

• MEDIUM

• LARGE

• XLARGE

• LARGE_2X

• LARGE_4X

• LARGE_8X (not available in all regions)

• LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

• T2_SMALL: A t2.small instance type.

• T2_MEDIUM: A t2.medium instance type.

• R4_LARGE: A r4.large instance type.

• R4_XLARGE: A r4.xlarge instance type.

• R4_2XLARGE: A r4.2xlarge instance type.

• R4_4XLARGE: A r4.4xlarge instance type.

• R4_8XLARGE: A r4.8xlarge instance type.

pub fn health_metrics_config(&self) -> Option<&CacheHealthMetricsConfig>

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

• NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.

• EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.

impl UpdateApiCacheInput

pub fn builder() -> UpdateApiCacheInputBuilder

Creates a new builder-style object to manufacture UpdateApiCacheInput.

Trait Implementations

impl Clone for UpdateApiCacheInput

fn clone(&self) -> UpdateApiCacheInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateApiCacheInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateApiCacheInput

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