@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ApiCache extends Object implements Serializable, Cloneable, StructuredPojo
The ApiCache object.
| Constructor and Description |
|---|
ApiCache() |
| Modifier and Type | Method and Description |
|---|---|
ApiCache |
clone() |
boolean |
equals(Object obj) |
String |
getApiCachingBehavior()
Caching behavior.
|
Boolean |
getAtRestEncryptionEnabled()
At-rest encryption flag for cache.
|
String |
getHealthMetricsConfig()
Controls how cache health metrics will be emitted to CloudWatch.
|
String |
getStatus()
The cache instance status.
|
Boolean |
getTransitEncryptionEnabled()
Transit encryption flag when connecting to cache.
|
Long |
getTtl()
TTL in seconds for cache entries.
|
String |
getType()
The cache instance type.
|
int |
hashCode() |
Boolean |
isAtRestEncryptionEnabled()
At-rest encryption flag for cache.
|
Boolean |
isTransitEncryptionEnabled()
Transit encryption flag when connecting to cache.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setApiCachingBehavior(String apiCachingBehavior)
Caching behavior.
|
void |
setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
At-rest encryption flag for cache.
|
void |
setHealthMetricsConfig(String healthMetricsConfig)
Controls how cache health metrics will be emitted to CloudWatch.
|
void |
setStatus(String status)
The cache instance status.
|
void |
setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
Transit encryption flag when connecting to cache.
|
void |
setTtl(Long ttl)
TTL in seconds for cache entries.
|
void |
setType(String type)
The cache instance type.
|
String |
toString()
Returns a string representation of this object.
|
ApiCache |
withApiCachingBehavior(ApiCachingBehavior apiCachingBehavior)
Caching behavior.
|
ApiCache |
withApiCachingBehavior(String apiCachingBehavior)
Caching behavior.
|
ApiCache |
withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
At-rest encryption flag for cache.
|
ApiCache |
withHealthMetricsConfig(CacheHealthMetricsConfig healthMetricsConfig)
Controls how cache health metrics will be emitted to CloudWatch.
|
ApiCache |
withHealthMetricsConfig(String healthMetricsConfig)
Controls how cache health metrics will be emitted to CloudWatch.
|
ApiCache |
withStatus(ApiCacheStatus status)
The cache instance status.
|
ApiCache |
withStatus(String status)
The cache instance status.
|
ApiCache |
withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
Transit encryption flag when connecting to cache.
|
ApiCache |
withTtl(Long ttl)
TTL in seconds for cache entries.
|
ApiCache |
withType(ApiCacheType type)
The cache instance type.
|
ApiCache |
withType(String type)
The cache instance type.
|
public void setTtl(Long ttl)
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
ttl - TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
public Long getTtl()
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
Valid values are 1–3,600 seconds.
public ApiCache withTtl(Long ttl)
TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
ttl - TTL in seconds for cache entries.
Valid values are 1–3,600 seconds.
public void setApiCachingBehavior(String apiCachingBehavior)
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
apiCachingBehavior - Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehaviorpublic String getApiCachingBehavior()
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehaviorpublic ApiCache withApiCachingBehavior(String apiCachingBehavior)
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
apiCachingBehavior - Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehaviorpublic ApiCache withApiCachingBehavior(ApiCachingBehavior apiCachingBehavior)
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
apiCachingBehavior - Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehaviorpublic void setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
transitEncryptionEnabled - Transit encryption flag when connecting to cache. You cannot update this setting after creation.public Boolean getTransitEncryptionEnabled()
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
public ApiCache withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
transitEncryptionEnabled - Transit encryption flag when connecting to cache. You cannot update this setting after creation.public Boolean isTransitEncryptionEnabled()
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
public void setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
At-rest encryption flag for cache. You cannot update this setting after creation.
atRestEncryptionEnabled - At-rest encryption flag for cache. You cannot update this setting after creation.public Boolean getAtRestEncryptionEnabled()
At-rest encryption flag for cache. You cannot update this setting after creation.
public ApiCache withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
At-rest encryption flag for cache. You cannot update this setting after creation.
atRestEncryptionEnabled - At-rest encryption flag for cache. You cannot update this setting after creation.public Boolean isAtRestEncryptionEnabled()
At-rest encryption flag for cache. You cannot update this setting after creation.
public void setType(String 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.
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.
ApiCacheTypepublic String getType()
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.
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.
ApiCacheTypepublic ApiCache withType(String 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.
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.
ApiCacheTypepublic ApiCache withType(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.
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.
ApiCacheTypepublic void setStatus(String 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.
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.
ApiCacheStatuspublic String getStatus()
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.
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.
ApiCacheStatuspublic ApiCache withStatus(String 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.
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.
ApiCacheStatuspublic ApiCache withStatus(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.
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.
ApiCacheStatuspublic void setHealthMetricsConfig(String 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.
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.
CacheHealthMetricsConfigpublic String getHealthMetricsConfig()
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.
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.
CacheHealthMetricsConfigpublic ApiCache withHealthMetricsConfig(String 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.
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.
CacheHealthMetricsConfigpublic ApiCache withHealthMetricsConfig(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.
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.
CacheHealthMetricsConfigpublic String toString()
toString in class ObjectObject.toString()public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.