Interface ApiCache.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ApiCache.Builder,ApiCache>
,SdkBuilder<ApiCache.Builder,ApiCache>
,SdkPojo
- Enclosing class:
- ApiCache
public static interface ApiCache.Builder extends SdkPojo, CopyableBuilder<ApiCache.Builder,ApiCache>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ApiCache.Builder
apiCachingBehavior(String apiCachingBehavior)
Caching behavior.ApiCache.Builder
apiCachingBehavior(ApiCachingBehavior apiCachingBehavior)
Caching behavior.ApiCache.Builder
atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
At-rest encryption flag for cache.ApiCache.Builder
status(String status)
The cache instance status.ApiCache.Builder
status(ApiCacheStatus status)
The cache instance status.ApiCache.Builder
transitEncryptionEnabled(Boolean transitEncryptionEnabled)
Transit encryption flag when connecting to cache.ApiCache.Builder
ttl(Long ttl)
TTL in seconds for cache entries.ApiCache.Builder
type(String type)
The cache instance type.ApiCache.Builder
type(ApiCacheType type)
The cache instance type.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
ttl
ApiCache.Builder ttl(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.
-
apiCachingBehavior
ApiCache.Builder apiCachingBehavior(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
,ApiCachingBehavior
-
-
apiCachingBehavior
ApiCache.Builder apiCachingBehavior(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
,ApiCachingBehavior
-
-
transitEncryptionEnabled
ApiCache.Builder transitEncryptionEnabled(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.
-
atRestEncryptionEnabled
ApiCache.Builder atRestEncryptionEnabled(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.
-
type
ApiCache.Builder type(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
,ApiCacheType
-
-
type
ApiCache.Builder type(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
,ApiCacheType
-
-
status
ApiCache.Builder status(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
,ApiCacheStatus
-
-
status
ApiCache.Builder status(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
,ApiCacheStatus
-
-
-