Skip to content

/AWS1/CL_APY=>UPDATEAPICACHE()

About UpdateApiCache

Updates the cache for the GraphQL API.

Method Signature

IMPORTING

Required arguments:

IV_APIID TYPE /AWS1/APYSTRING /AWS1/APYSTRING

The GraphQL API ID.

IV_TTL TYPE /AWS1/APYLONG /AWS1/APYLONG

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

IV_APICACHINGBEHAVIOR TYPE /AWS1/APYAPICACHINGBEHAVIOR /AWS1/APYAPICACHINGBEHAVIOR

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

IV_TYPE TYPE /AWS1/APYAPICACHETYPE /AWS1/APYAPICACHETYPE

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.

Optional arguments:

IV_HEALTHMETRICSCONFIG TYPE /AWS1/APYCACHEHEALTHMETCONFIG /AWS1/APYCACHEHEALTHMETCONFIG

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_APYUPDATEAPICACHERSP /AWS1/CL_APYUPDATEAPICACHERSP