Class: Aws::AppSync::Types::CreateApiCacheRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppSync::Types::CreateApiCacheRequest
- Defined in:
- gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb
Overview
Represents the input of a CreateApiCache
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_caching_behavior ⇒ String
Caching behavior.
-
#api_id ⇒ String
The GraphQL API ID.
-
#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.
-
#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.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :health_metrics_config) SENSITIVE = [] include Aws::Structure end |
#api_id ⇒ String
The GraphQL API ID.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :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.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :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
.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :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.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :health_metrics_config) SENSITIVE = [] include Aws::Structure end |
#ttl ⇒ Integer
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :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.
987 988 989 990 991 992 993 994 995 996 997 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 987 class CreateApiCacheRequest < Struct.new( :api_id, :ttl, :transit_encryption_enabled, :at_rest_encryption_enabled, :api_caching_behavior, :type, :health_metrics_config) SENSITIVE = [] include Aws::Structure end |