java.lang.Object
- software.amazon.awssdk.services.appsync.model.ApiCache

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ApiCache.Builder,ApiCache>

@Generated("software.amazon.awssdk:codegen")
public final class ApiCache
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApiCache.Builder,ApiCache>

The ApiCache object.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ApiCache.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiCachingBehavior`	`apiCachingBehavior()`	Caching behavior.
`String`	`apiCachingBehaviorAsString()`	Caching behavior.
`Boolean`	`atRestEncryptionEnabled()`	At-rest encryption flag for cache.
`static ApiCache.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`CacheHealthMetricsConfig`	`healthMetricsConfig()`	Controls how cache health metrics will be emitted to CloudWatch.
`String`	`healthMetricsConfigAsString()`	Controls how cache health metrics will be emitted to CloudWatch.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ApiCache.Builder>`	`serializableBuilderClass()`
`ApiCacheStatus`	`status()`	The cache instance status.
`String`	`statusAsString()`	The cache instance status.
`ApiCache.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`transitEncryptionEnabled()`	Transit encryption flag when connecting to cache.
`Long`	`ttl()`	TTL in seconds for cache entries.
`ApiCacheType`	`type()`	The cache instance type.
`String`	`typeAsString()`	The cache instance type.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ttl
```
public final Long 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
```
public final ApiCachingBehavior 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 return ApiCachingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiCachingBehaviorAsString().
    Returns:
    
    Caching behavior.
    
    FULL_REQUEST_CACHING: All requests are fully cached.
    
    PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
    
    See Also:
    
    ApiCachingBehavior
  - apiCachingBehaviorAsString
```
public final String 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 return ApiCachingBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiCachingBehaviorAsString().
    Returns:
    
    Caching behavior.
    
    FULL_REQUEST_CACHING: All requests are fully cached.
    
    PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
    
    See Also:
    
    ApiCachingBehavior
  - transitEncryptionEnabled
```
public final Boolean 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
```
public final Boolean 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
```
public final ApiCacheType 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 return ApiCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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:
    
    ApiCacheType
  - typeAsString
```
public final String 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 return ApiCacheType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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:
    
    ApiCacheType
  - status
```
public final ApiCacheStatus 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 return ApiCacheStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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:
    
    ApiCacheStatus
  - statusAsString
```
public final String 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 return ApiCacheStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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:
    
    ApiCacheStatus
  - healthMetricsConfig
```
public final CacheHealthMetricsConfig 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 or DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, healthMetricsConfig will return CacheHealthMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthMetricsConfigAsString().
    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 or DISABLED.
    
    See Also:
    
    CacheHealthMetricsConfig
  - healthMetricsConfigAsString
```
public final String 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 or DISABLED.
    
    If the service returns an enum value that is not available in the current SDK version, healthMetricsConfig will return CacheHealthMetricsConfig.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthMetricsConfigAsString().
    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 or DISABLED.
    
    See Also:
    
    CacheHealthMetricsConfig
  - toBuilder
```
public ApiCache.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ApiCache.Builder,ApiCache>
  - builder
```
public static ApiCache.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ApiCache.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ApiCache

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ttl

apiCachingBehavior

apiCachingBehaviorAsString

transitEncryptionEnabled

atRestEncryptionEnabled

type

typeAsString

status

statusAsString

healthMetricsConfig

healthMetricsConfigAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields