Interface ServerlessCache.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ServerlessCache.Builder,ServerlessCache>
,SdkBuilder<ServerlessCache.Builder,ServerlessCache>
,SdkPojo
- Enclosing class:
- ServerlessCache
public static interface ServerlessCache.Builder extends SdkPojo, CopyableBuilder<ServerlessCache.Builder,ServerlessCache>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ServerlessCache.Builder
arn(String arn)
The Amazon Resource Name (ARN) of the serverless cache.default ServerlessCache.Builder
cacheUsageLimits(Consumer<CacheUsageLimits.Builder> cacheUsageLimits)
The cache usage limit for the serverless cache.ServerlessCache.Builder
cacheUsageLimits(CacheUsageLimits cacheUsageLimits)
The cache usage limit for the serverless cache.ServerlessCache.Builder
createTime(Instant createTime)
When the serverless cache was created.ServerlessCache.Builder
dailySnapshotTime(String dailySnapshotTime)
The daily time that a cache snapshot will be created.ServerlessCache.Builder
description(String description)
A description of the serverless cache.default ServerlessCache.Builder
endpoint(Consumer<Endpoint.Builder> endpoint)
Sets the value of the Endpoint property for this object.ServerlessCache.Builder
endpoint(Endpoint endpoint)
Sets the value of the Endpoint property for this object.ServerlessCache.Builder
engine(String engine)
The engine the serverless cache is compatible with.ServerlessCache.Builder
fullEngineVersion(String fullEngineVersion)
The name and version number of the engine the serverless cache is compatible with.ServerlessCache.Builder
kmsKeyId(String kmsKeyId)
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.ServerlessCache.Builder
majorEngineVersion(String majorEngineVersion)
The version number of the engine the serverless cache is compatible with.default ServerlessCache.Builder
readerEndpoint(Consumer<Endpoint.Builder> readerEndpoint)
Sets the value of the ReaderEndpoint property for this object.ServerlessCache.Builder
readerEndpoint(Endpoint readerEndpoint)
Sets the value of the ReaderEndpoint property for this object.ServerlessCache.Builder
securityGroupIds(String... securityGroupIds)
The IDs of the EC2 security groups associated with the serverless cache.ServerlessCache.Builder
securityGroupIds(Collection<String> securityGroupIds)
The IDs of the EC2 security groups associated with the serverless cache.ServerlessCache.Builder
serverlessCacheName(String serverlessCacheName)
The unique identifier of the serverless cache.ServerlessCache.Builder
snapshotRetentionLimit(Integer snapshotRetentionLimit)
The current setting for the number of serverless cache snapshots the system will retain.ServerlessCache.Builder
status(String status)
The current status of the serverless cache.ServerlessCache.Builder
subnetIds(String... subnetIds)
If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.ServerlessCache.Builder
subnetIds(Collection<String> subnetIds)
If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.ServerlessCache.Builder
userGroupId(String userGroupId)
The identifier of the user group associated with the serverless cache.-
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
-
serverlessCacheName
ServerlessCache.Builder serverlessCacheName(String serverlessCacheName)
The unique identifier of the serverless cache.
- Parameters:
serverlessCacheName
- The unique identifier of the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
ServerlessCache.Builder description(String description)
A description of the serverless cache.
- Parameters:
description
- A description of the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTime
ServerlessCache.Builder createTime(Instant createTime)
When the serverless cache was created.
- Parameters:
createTime
- When the serverless cache was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
ServerlessCache.Builder status(String status)
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
- Parameters:
status
- The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engine
ServerlessCache.Builder engine(String engine)
The engine the serverless cache is compatible with.
- Parameters:
engine
- The engine the serverless cache is compatible with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
majorEngineVersion
ServerlessCache.Builder majorEngineVersion(String majorEngineVersion)
The version number of the engine the serverless cache is compatible with.
- Parameters:
majorEngineVersion
- The version number of the engine the serverless cache is compatible with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fullEngineVersion
ServerlessCache.Builder fullEngineVersion(String fullEngineVersion)
The name and version number of the engine the serverless cache is compatible with.
- Parameters:
fullEngineVersion
- The name and version number of the engine the serverless cache is compatible with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheUsageLimits
ServerlessCache.Builder cacheUsageLimits(CacheUsageLimits cacheUsageLimits)
The cache usage limit for the serverless cache.
- Parameters:
cacheUsageLimits
- The cache usage limit for the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheUsageLimits
default ServerlessCache.Builder cacheUsageLimits(Consumer<CacheUsageLimits.Builder> cacheUsageLimits)
The cache usage limit for the serverless cache.
This is a convenience method that creates an instance of theCacheUsageLimits.Builder
avoiding the need to create one manually viaCacheUsageLimits.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheUsageLimits(CacheUsageLimits)
.- Parameters:
cacheUsageLimits
- a consumer that will call methods onCacheUsageLimits.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
cacheUsageLimits(CacheUsageLimits)
-
kmsKeyId
ServerlessCache.Builder kmsKeyId(String kmsKeyId)
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
- Parameters:
kmsKeyId
- The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
ServerlessCache.Builder securityGroupIds(Collection<String> securityGroupIds)
The IDs of the EC2 security groups associated with the serverless cache.
- Parameters:
securityGroupIds
- The IDs of the EC2 security groups associated with the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
ServerlessCache.Builder securityGroupIds(String... securityGroupIds)
The IDs of the EC2 security groups associated with the serverless cache.
- Parameters:
securityGroupIds
- The IDs of the EC2 security groups associated with the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpoint
ServerlessCache.Builder endpoint(Endpoint endpoint)
Sets the value of the Endpoint property for this object.- Parameters:
endpoint
- The new value for the Endpoint property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpoint
default ServerlessCache.Builder endpoint(Consumer<Endpoint.Builder> endpoint)
Sets the value of the Endpoint property for this object. This is a convenience method that creates an instance of theEndpoint.Builder
avoiding the need to create one manually viaEndpoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpoint(Endpoint)
.- Parameters:
endpoint
- a consumer that will call methods onEndpoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
endpoint(Endpoint)
-
readerEndpoint
ServerlessCache.Builder readerEndpoint(Endpoint readerEndpoint)
Sets the value of the ReaderEndpoint property for this object.- Parameters:
readerEndpoint
- The new value for the ReaderEndpoint property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readerEndpoint
default ServerlessCache.Builder readerEndpoint(Consumer<Endpoint.Builder> readerEndpoint)
Sets the value of the ReaderEndpoint property for this object. This is a convenience method that creates an instance of theEndpoint.Builder
avoiding the need to create one manually viaEndpoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreaderEndpoint(Endpoint)
.- Parameters:
readerEndpoint
- a consumer that will call methods onEndpoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
readerEndpoint(Endpoint)
-
arn
ServerlessCache.Builder arn(String arn)
The Amazon Resource Name (ARN) of the serverless cache.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the serverless cache.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userGroupId
ServerlessCache.Builder userGroupId(String userGroupId)
The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
- Parameters:
userGroupId
- The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
ServerlessCache.Builder subnetIds(Collection<String> subnetIds)
If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
- Parameters:
subnetIds
- If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
ServerlessCache.Builder subnetIds(String... subnetIds)
If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
- Parameters:
subnetIds
- If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotRetentionLimit
ServerlessCache.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)
The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
snapshotRetentionLimit
- The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dailySnapshotTime
ServerlessCache.Builder dailySnapshotTime(String dailySnapshotTime)
The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
dailySnapshotTime
- The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-