Interface ApiCache.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ApiCache.Builder,
,ApiCache> SdkBuilder<ApiCache.Builder,
,ApiCache> SdkPojo
- Enclosing class:
ApiCache
-
Method Summary
Modifier and TypeMethodDescriptionapiCachingBehavior
(String apiCachingBehavior) Caching behavior.apiCachingBehavior
(ApiCachingBehavior apiCachingBehavior) Caching behavior.atRestEncryptionEnabled
(Boolean atRestEncryptionEnabled) At-rest encryption flag for cache.healthMetricsConfig
(String healthMetricsConfig) Controls how cache health metrics will be emitted to CloudWatch.healthMetricsConfig
(CacheHealthMetricsConfig healthMetricsConfig) Controls how cache health metrics will be emitted to CloudWatch.The cache instance status.status
(ApiCacheStatus status) The cache instance status.transitEncryptionEnabled
(Boolean transitEncryptionEnabled) Transit encryption flag when connecting to cache.TTL in seconds for cache entries.The cache instance type.type
(ApiCacheType type) The cache instance type.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
ttl
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- Parameters:
ttl
- TTL in seconds for cache entries.Valid values are 1–3,600 seconds.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiCachingBehavior
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
- Parameters:
apiCachingBehavior
- Caching behavior.-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
apiCachingBehavior
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
- Parameters:
apiCachingBehavior
- Caching behavior.-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
transitEncryptionEnabled
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
- Parameters:
transitEncryptionEnabled
- Transit encryption flag when connecting to cache. You cannot update this setting after creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
atRestEncryptionEnabled
At-rest encryption flag for cache. You cannot update this setting after creation.
- Parameters:
atRestEncryptionEnabled
- At-rest encryption flag for cache. You cannot update this setting after creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
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.
- Parameters:
type
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
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.
- Parameters:
type
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
status
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.
- Parameters:
status
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
status
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.
- Parameters:
status
- 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
healthMetricsConfig
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
orDISABLED
.- Parameters:
healthMetricsConfig
- 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
orDISABLED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
healthMetricsConfig
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
orDISABLED
.- Parameters:
healthMetricsConfig
- 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
orDISABLED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-