AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::AppSync::Types::UpdateApiCacheRequest

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

Overview

Note:

When passing UpdateApiCacheRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  api_id: "String", # required
  ttl: 1, # required
  api_caching_behavior: "FULL_REQUEST_CACHING", # required, accepts FULL_REQUEST_CACHING, PER_RESOLVER_CACHING
  type: "T2_SMALL", # required, accepts 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
}

Represents the input of a UpdateApiCache operation.

Instance Attribute Summary collapse

Instance Attribute Details

#api_caching_behaviorString

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.

  • PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.

    Possible values:

    • FULL_REQUEST_CACHING
    • PER_RESOLVER_CACHING

Returns:

  • (String)

    Caching behavior.

#api_idString

The GraphQL API Id.

Returns:

  • (String)

    The GraphQL API Id.

#ttlInteger

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Returns:

  • (Integer)

    TTL in seconds for cache entries.

#typeString

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 avaible, 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.