ApiCache (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appsync.model.ApiCache

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ApiCache
extends Object
implements Serializable, Cloneable, StructuredPojo

The ApiCache object.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApiCache()

Constructors
Constructor and Description
`ApiCache()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`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`	`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`	`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.

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

- Constructor Detail
  - ApiCache
```
public ApiCache()
```
- Method Detail
  - setTtl
```
public void setTtl(Long 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.
  - getTtl
```
public Long getTtl()
```
    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.
  - withTtl
```
public ApiCache withTtl(Long 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.
  - setApiCachingBehavior
```
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.
    Parameters:
    apiCachingBehavior - Caching behavior.
    
    FULL_REQUEST_CACHING: All requests are fully cached.
    
    PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
    See Also:
    
    ApiCachingBehavior
  - getApiCachingBehavior
```
public String getApiCachingBehavior()
```
    Caching behavior.
    - FULL_REQUEST_CACHING: All requests are fully cached.
    - PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
    Returns:
    Caching behavior.
    
    FULL_REQUEST_CACHING: All requests are fully cached.
    
    PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
    See Also:
    
    ApiCachingBehavior
  - withApiCachingBehavior
```
public ApiCache withApiCachingBehavior(String 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
  - withApiCachingBehavior
```
public ApiCache withApiCachingBehavior(ApiCachingBehavior 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
  - setTransitEncryptionEnabled
```
public void setTransitEncryptionEnabled(Boolean 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.
  - getTransitEncryptionEnabled
```
public Boolean getTransitEncryptionEnabled()
```
    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.
  - withTransitEncryptionEnabled
```
public ApiCache withTransitEncryptionEnabled(Boolean 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.
  - isTransitEncryptionEnabled
```
public Boolean isTransitEncryptionEnabled()
```
    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.
  - setAtRestEncryptionEnabled
```
public void setAtRestEncryptionEnabled(Boolean 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.
  - getAtRestEncryptionEnabled
```
public Boolean getAtRestEncryptionEnabled()
```
    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.
  - withAtRestEncryptionEnabled
```
public ApiCache withAtRestEncryptionEnabled(Boolean 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.
  - isAtRestEncryptionEnabled
```
public Boolean isAtRestEncryptionEnabled()
```
    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.
  - setType
```
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.
    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.
    See Also:
    
    ApiCacheType
  - getType
```
public 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.
    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
  - withType
```
public 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.
    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:
    
    ApiCacheType
  - withType
```
public 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.
    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:
    
    ApiCacheType
  - setStatus
```
public 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.
    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.
    See Also:
    
    ApiCacheStatus
  - getStatus
```
public 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.
    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
  - withStatus
```
public 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.
    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:
    
    ApiCacheStatus
  - withStatus
```
public 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.
    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:
    
    ApiCacheStatus
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ApiCache clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ApiCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiCache

Method Detail

setTtl

getTtl

withTtl

setApiCachingBehavior

getApiCachingBehavior

withApiCachingBehavior

withApiCachingBehavior

setTransitEncryptionEnabled

getTransitEncryptionEnabled

withTransitEncryptionEnabled

isTransitEncryptionEnabled

setAtRestEncryptionEnabled

getAtRestEncryptionEnabled

withAtRestEncryptionEnabled

isAtRestEncryptionEnabled

setType

getType

withType

withType

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall