java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.appsync.model.AppSyncRequest
    - - software.amazon.awssdk.services.appsync.model.CreateApiCacheRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateApiCacheRequest
extends AppSyncRequest
implements ToCopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>

Represents the input of a CreateApiCache operation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateApiCacheRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiCachingBehavior`	`apiCachingBehavior()`	Caching behavior.
`String`	`apiCachingBehaviorAsString()`	Caching behavior.
`String`	`apiId()`	The GraphQL API ID.
`Boolean`	`atRestEncryptionEnabled()`	At-rest encryption flag for cache.
`static CreateApiCacheRequest.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 CreateApiCacheRequest.Builder>`	`serializableBuilderClass()`
`CreateApiCacheRequest.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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - apiId
```
public final String apiId()
```
    The GraphQL API ID.
    
    Returns:
    
    The GraphQL API ID.
  - 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.
  - 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.
  - 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
  - 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
  - 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 CreateApiCacheRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>
    
    Specified by:
    
    toBuilder in class AppSyncRequest
  - builder
```
public static CreateApiCacheRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateApiCacheRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateApiCacheRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

apiId

ttl

transitEncryptionEnabled

atRestEncryptionEnabled

apiCachingBehavior

apiCachingBehaviorAsString

type

typeAsString

healthMetricsConfig

healthMetricsConfigAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields