Interface CreateApiCacheRequest.Builder
-
- All Superinterfaces:
AppSyncRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>
,SdkBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateApiCacheRequest
public static interface CreateApiCacheRequest.Builder extends AppSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateApiCacheRequest.Builder,CreateApiCacheRequest>
-
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.services.appsync.model.AppSyncRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
apiId
CreateApiCacheRequest.Builder apiId(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.
-
ttl
CreateApiCacheRequest.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.
-
transitEncryptionEnabled
CreateApiCacheRequest.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
CreateApiCacheRequest.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.
-
apiCachingBehavior
CreateApiCacheRequest.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
CreateApiCacheRequest.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
-
-
type
CreateApiCacheRequest.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
CreateApiCacheRequest.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
-
-
healthMetricsConfig
CreateApiCacheRequest.Builder healthMetricsConfig(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
orDISABLED
.- 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
orDISABLED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CacheHealthMetricsConfig
,CacheHealthMetricsConfig
-
-
healthMetricsConfig
CreateApiCacheRequest.Builder healthMetricsConfig(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
orDISABLED
.- 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
orDISABLED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CacheHealthMetricsConfig
,CacheHealthMetricsConfig
-
-
overrideConfiguration
CreateApiCacheRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateApiCacheRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-