You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppSync::Types::ApiCache

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The ApiCache object.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#api_caching_behavior ⇒ String

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

    Possible values:

    • FULL_REQUEST_CACHING
    • PER_RESOLVER_CACHING

Returns:

  • (String) —

    Caching behavior.

#at_rest_encryption_enabled ⇒ Boolean

At rest encryption flag for cache. This setting cannot be updated after creation.

Returns:

  • (Boolean) —

    At rest encryption flag for cache.

#status ⇒ String

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.

    Possible values:

    • AVAILABLE
    • CREATING
    • DELETING
    • MODIFYING
    • FAILED

Returns:

  • (String) —

    The cache instance status.

#transit_encryption_enabled ⇒ Boolean

Transit encryption flag when connecting to cache. This setting cannot be updated after creation.

Returns:

  • (Boolean) —

    Transit encryption flag when connecting to cache.

#ttl ⇒ Integer

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Returns:

  • (Integer) —

    TTL in seconds for cache entries.

#type ⇒ String

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.

    Possible values:

    • T2_SMALL
    • T2_MEDIUM
    • R4_LARGE
    • R4_XLARGE
    • R4_2XLARGE
    • R4_4XLARGE
    • R4_8XLARGE
    • SMALL
    • MEDIUM
    • LARGE
    • XLARGE
    • LARGE_2X
    • LARGE_4X
    • LARGE_8X
    • LARGE_12X

Returns:

  • (String) —

    The cache instance type.