Package software.amazon.awscdk.services.appsync

Interface CachingConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CachingConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-19T18:01:29.439Z")
@Stability(Stable)
public interface CachingConfig
extends software.amazon.jsii.JsiiSerializable

CachingConfig for AppSync resolvers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.appsync.*;
 CachingConfig cachingConfig = CachingConfig.builder()
         .ttl(Duration.minutes(30))
         // the properties below are optional
         .cachingKeys(List.of("cachingKeys"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CachingConfig.Builder	A builder for CachingConfig
static final class	CachingConfig.Jsii$Proxy	An implementation for CachingConfig

Method Summary

Modifier and Type	Method	Description
static CachingConfig.Builder	builder()
default List<String>	getCachingKeys()	The caching keys for a resolver that has caching enabled.
Duration	getTtl()	The TTL in seconds for a resolver that has caching enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTtl

@Stability(Stable)
@NotNull
Duration getTtl()

The TTL in seconds for a resolver that has caching enabled.

Valid values are between 1 and 3600 seconds.

getCachingKeys

@Stability(Stable)
@Nullable
default List<String> getCachingKeys()

The caching keys for a resolver that has caching enabled.

Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.

Default: - No caching keys

builder

@Stability(Stable)
static CachingConfig.Builder builder()

Returns:

a CachingConfig.Builder of CachingConfig