Class ApiCache
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ApiCache.Builder,
ApiCache>
The ApiCache
object.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ApiCachingBehavior
Caching behavior.final String
Caching behavior.final Boolean
At-rest encryption flag for cache.static ApiCache.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final CacheHealthMetricsConfig
Controls how cache health metrics will be emitted to CloudWatch.final String
Controls how cache health metrics will be emitted to CloudWatch.static Class
<? extends ApiCache.Builder> final ApiCacheStatus
status()
The cache instance status.final String
The cache instance status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Transit encryption flag when connecting to cache.final Long
ttl()
TTL in seconds for cache entries.final ApiCacheType
type()
The cache instance type.final String
The cache instance type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ttl
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
- Returns:
- TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
-
apiCachingBehavior
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
If the service returns an enum value that is not available in the current SDK version,
apiCachingBehavior
will returnApiCachingBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiCachingBehaviorAsString()
.- Returns:
- Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
- See Also:
-
-
apiCachingBehaviorAsString
Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
If the service returns an enum value that is not available in the current SDK version,
apiCachingBehavior
will returnApiCachingBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapiCachingBehaviorAsString()
.- Returns:
- Caching behavior.
-
FULL_REQUEST_CACHING: All requests are fully cached.
-
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
-
- See Also:
-
-
transitEncryptionEnabled
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
- Returns:
- Transit encryption flag when connecting to cache. You cannot update this setting after creation.
-
atRestEncryptionEnabled
At-rest encryption flag for cache. You cannot update this setting after creation.
- Returns:
- At-rest encryption flag for cache. You cannot update this setting after creation.
-
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnApiCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
typeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnApiCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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.
-
- 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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnApiCacheStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
statusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnApiCacheStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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.
-
- 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
.If the service returns an enum value that is not available in the current SDK version,
healthMetricsConfig
will returnCacheHealthMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthMetricsConfigAsString()
.- Returns:
- 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
. -
- See Also:
-
-
healthMetricsConfigAsString
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
.If the service returns an enum value that is not available in the current SDK version,
healthMetricsConfig
will returnCacheHealthMetricsConfig.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthMetricsConfigAsString()
.- Returns:
- 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
. -
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ApiCache.Builder,
ApiCache> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-