CreateApiCacheRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.appsync.model.CreateApiCacheRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateApiCacheRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input of a CreateApiCache operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateApiCacheRequest()

Constructors
Constructor and Description
`CreateApiCacheRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateApiCacheRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getApiCachingBehavior()` Caching behavior.
`String`	`getApiId()` The GraphQL API ID.
`Boolean`	`getAtRestEncryptionEnabled()` At-rest encryption flag for cache.
`String`	`getHealthMetricsConfig()` Controls how cache health metrics will be emitted to CloudWatch.
`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`	`setApiCachingBehavior(String apiCachingBehavior)` Caching behavior.
`void`	`setApiId(String apiId)` The GraphQL API ID.
`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`	`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.
`CreateApiCacheRequest`	`withApiCachingBehavior(ApiCachingBehavior apiCachingBehavior)` Caching behavior.
`CreateApiCacheRequest`	`withApiCachingBehavior(String apiCachingBehavior)` Caching behavior.
`CreateApiCacheRequest`	`withApiId(String apiId)` The GraphQL API ID.
`CreateApiCacheRequest`	`withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)` At-rest encryption flag for cache.
`CreateApiCacheRequest`	`withHealthMetricsConfig(CacheHealthMetricsConfig healthMetricsConfig)` Controls how cache health metrics will be emitted to CloudWatch.
`CreateApiCacheRequest`	`withHealthMetricsConfig(String healthMetricsConfig)` Controls how cache health metrics will be emitted to CloudWatch.
`CreateApiCacheRequest`	`withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)` Transit encryption flag when connecting to cache.
`CreateApiCacheRequest`	`withTtl(Long ttl)` TTL in seconds for cache entries.
`CreateApiCacheRequest`	`withType(ApiCacheType type)` The cache instance type.
`CreateApiCacheRequest`	`withType(String type)` The cache instance type.

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

- Constructor Detail
  - CreateApiCacheRequest
```
public CreateApiCacheRequest()
```
- Method Detail
  - setApiId
```
public void setApiId(String apiId)
```
    The GraphQL API ID.
    
    Parameters:
    
    apiId - The GraphQL API ID.
  - getApiId
```
public String getApiId()
```
    The GraphQL API ID.
    
    Returns:
    
    The GraphQL API ID.
  - withApiId
```
public CreateApiCacheRequest withApiId(String apiId)
```
    The GraphQL API ID.
    
    Parameters:
    
    apiId - The GraphQL API ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CreateApiCacheRequest 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.
  - 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 CreateApiCacheRequest 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 CreateApiCacheRequest 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.
  - 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 CreateApiCacheRequest 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 CreateApiCacheRequest 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
  - 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 CreateApiCacheRequest 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 CreateApiCacheRequest 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
  - setHealthMetricsConfig
```
public 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.
    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 or DISABLED.
    See Also:
    
    CacheHealthMetricsConfig
  - getHealthMetricsConfig
```
public 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.
    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
  - withHealthMetricsConfig
```
public CreateApiCacheRequest 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.
    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 or DISABLED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheHealthMetricsConfig
  - withHealthMetricsConfig
```
public CreateApiCacheRequest 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.
    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 or DISABLED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CacheHealthMetricsConfig
  - 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 CreateApiCacheRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.792

Class CreateApiCacheRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateApiCacheRequest

Method Detail

setApiId

getApiId

withApiId

setTtl

getTtl

withTtl

setTransitEncryptionEnabled

getTransitEncryptionEnabled

withTransitEncryptionEnabled

isTransitEncryptionEnabled

setAtRestEncryptionEnabled

getAtRestEncryptionEnabled

withAtRestEncryptionEnabled

isAtRestEncryptionEnabled

setApiCachingBehavior

getApiCachingBehavior

withApiCachingBehavior

withApiCachingBehavior

setType

getType

withType

withType

setHealthMetricsConfig

getHealthMetricsConfig

withHealthMetricsConfig

withHealthMetricsConfig

toString

equals

hashCode

clone