Class CreateApiCacheRequest

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

Modifier and Type	Method	Description
final ApiCachingBehavior	apiCachingBehavior()	Caching behavior.
final String	apiCachingBehaviorAsString()	Caching behavior.
final String	apiId()	The GraphQL API ID.
final Boolean	atRestEncryptionEnabled()	Deprecated. atRestEncryptionEnabled attribute is deprecated.
static CreateApiCacheRequest.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final CacheHealthMetricsConfig	healthMetricsConfig()	Controls how cache health metrics will be emitted to CloudWatch.
final String	healthMetricsConfigAsString()	Controls how cache health metrics will be emitted to CloudWatch.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CreateApiCacheRequest.Builder>	serializableBuilderClass()
CreateApiCacheRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final Boolean	transitEncryptionEnabled()	Deprecated. transitEncryptionEnabled attribute is deprecated.
final Long	ttl()	TTL in seconds for cache entries.
final ApiCacheType	type()	The cache instance type.
final String	typeAsString()	The cache instance type.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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

@Deprecated
public final Boolean transitEncryptionEnabled()

Deprecated.

transitEncryptionEnabled attribute is deprecated. Encryption in transit is always enabled.

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

@Deprecated
public final Boolean atRestEncryptionEnabled()

Deprecated.

atRestEncryptionEnabled attribute is deprecated. Encryption at rest is always enabled.

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 from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

• OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

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 from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

• OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

See Also:

• ApiCachingBehavior

apiCachingBehaviorAsString

public final String apiCachingBehaviorAsString()

Caching behavior.

• FULL_REQUEST_CACHING: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

• OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

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 from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.

• PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

• OPERATION_LEVEL_CACHING: Full requests are cached together and returned without executing resolvers.

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>

Specified by:

toBuilder in class AppSyncRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.