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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

The ApiCache object.

Constant Summary collapse

SENSITIVE =
[]

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.

Returns:

  • (String)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#at_rest_encryption_enabledBoolean

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

Returns:

  • (Boolean)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_enabledBoolean

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

Returns:

  • (Boolean)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#ttlInteger

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

Returns:

  • (Integer)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String)


153
154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 153

class ApiCache < Struct.new(
  :ttl,
  :api_caching_behavior,
  :transit_encryption_enabled,
  :at_rest_encryption_enabled,
  :type,
  :status)
  SENSITIVE = []
  include Aws::Structure
end