Struct aws_sdk_appsync::types::ApiCache

#[non_exhaustive]
pub struct ApiCache {
    pub ttl: i64,
    pub api_caching_behavior: Option<ApiCachingBehavior>,
    pub transit_encryption_enabled: bool,
    pub at_rest_encryption_enabled: bool,
    pub type: Option<ApiCacheType>,
    pub status: Option<ApiCacheStatus>,
    pub health_metrics_config: Option<CacheHealthMetricsConfig>,
}

The ApiCache object.

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.

ttl: 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.

transit_encryption_enabled: bool

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

at_rest_encryption_enabled: bool

At-rest encryption flag for cache. You cannot update this setting after creation.

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.

status: Option<ApiCacheStatus>

The cache instance status.

• AVAILABLE: The instance is available for use.

• CREATING: The instance is currently creating.

• DELETING: The instance is currently deleting.

• MODIFYING: The instance is currently modifying.

• FAILED: The instance has failed creation.

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 ApiCache

pub fn ttl(&self) -> 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 transit_encryption_enabled(&self) -> bool

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

pub fn at_rest_encryption_enabled(&self) -> bool

At-rest encryption flag for cache. You cannot update this setting after creation.

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 status(&self) -> Option<&ApiCacheStatus>

The cache instance status.

• AVAILABLE: The instance is available for use.

• CREATING: The instance is currently creating.

• DELETING: The instance is currently deleting.

• MODIFYING: The instance is currently modifying.

• FAILED: The instance has failed creation.

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 ApiCache

pub fn builder() -> ApiCacheBuilder

Creates a new builder-style object to manufacture ApiCache.

Trait Implementations

impl Clone for ApiCache

fn clone(&self) -> ApiCache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiCache

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

Formats the value using the given formatter.

impl PartialEq for ApiCache

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ApiCache