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

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::ApiCache

Defined in:

gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

The ApiCache object.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_caching_behavior ⇒ String

  Caching behavior.

• #at_rest_encryption_enabled ⇒ Boolean

  At-rest encryption flag for cache.

• #health_metrics_config ⇒ String

  Controls how cache health metrics will be emitted to CloudWatch.

• #status ⇒ String

  The cache instance status.

• #transit_encryption_enabled ⇒ Boolean

  Transit encryption flag when connecting to cache.

• #ttl ⇒ Integer

  TTL in seconds for cache entries.

• #type ⇒ String

  The cache instance type.

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.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

#at_rest_encryption_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

#health_metrics_config ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

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

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

#transit_encryption_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

#ttl ⇒ Integer

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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

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

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 195

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