Skip to content

/AWS1/CL_APYAPICACHE

The ApiCache object.

CONSTRUCTOR

IMPORTING

Optional arguments:

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 from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

  • OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

iv_transitencryptionenabled TYPE /AWS1/APYBOOLEAN /AWS1/APYBOOLEAN

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

iv_atrestencryptionenabled TYPE /AWS1/APYBOOLEAN /AWS1/APYBOOLEAN

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

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.

iv_status TYPE /AWS1/APYAPICACHESTATUS /AWS1/APYAPICACHESTATUS

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.

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.

Queryable Attributes

ttl

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

Accessible with the following methods

Method Description
GET_TTL() Getter for TTL

apiCachingBehavior

Caching behavior.

  • FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

  • OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

Accessible with the following methods

Method Description
GET_APICACHINGBEHAVIOR() Getter for APICACHINGBEHAVIOR, with configurable default
ASK_APICACHINGBEHAVIOR() Getter for APICACHINGBEHAVIOR w/ exceptions if field has no
HAS_APICACHINGBEHAVIOR() Determine if APICACHINGBEHAVIOR has a value

transitEncryptionEnabled

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

Accessible with the following methods

Method Description
GET_TRANSITENCRYPTIONENABLED() Getter for TRANSITENCRYPTIONENABLED

atRestEncryptionEnabled

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

Accessible with the following methods

Method Description
GET_ATRESTENCRYPTIONENABLED() Getter for ATRESTENCRYPTIONENABLED

type

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.

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

status

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

healthMetricsConfig

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.

Accessible with the following methods

Method Description
GET_HEALTHMETRICSCONFIG() Getter for HEALTHMETRICSCONFIG, with configurable default
ASK_HEALTHMETRICSCONFIG() Getter for HEALTHMETRICSCONFIG w/ exceptions if field has no
HAS_HEALTHMETRICSCONFIG() Determine if HEALTHMETRICSCONFIG has a value