Package software.amazon.awscdk.services.elasticache

Class CfnServerlessCacheProps.Builder

java.lang.Object

software.amazon.awscdk.services.elasticache.CfnServerlessCacheProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServerlessCacheProps>

Enclosing interface:

CfnServerlessCacheProps

@Stability(Stable)
public static final class CfnServerlessCacheProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServerlessCacheProps>

A builder for CfnServerlessCacheProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnServerlessCacheProps	build()	Builds the configured instance.
CfnServerlessCacheProps.Builder	cacheUsageLimits(IResolvable cacheUsageLimits)	Sets the value of CfnServerlessCacheProps.getCacheUsageLimits()
CfnServerlessCacheProps.Builder	cacheUsageLimits(CfnServerlessCache.CacheUsageLimitsProperty cacheUsageLimits)	Sets the value of CfnServerlessCacheProps.getCacheUsageLimits()
CfnServerlessCacheProps.Builder	dailySnapshotTime(String dailySnapshotTime)	Sets the value of CfnServerlessCacheProps.getDailySnapshotTime()
CfnServerlessCacheProps.Builder	description(String description)	Sets the value of CfnServerlessCacheProps.getDescription()
CfnServerlessCacheProps.Builder	endpoint(IResolvable endpoint)	Sets the value of CfnServerlessCacheProps.getEndpoint()
CfnServerlessCacheProps.Builder	endpoint(CfnServerlessCache.EndpointProperty endpoint)	Sets the value of CfnServerlessCacheProps.getEndpoint()
CfnServerlessCacheProps.Builder	engine(String engine)	Sets the value of CfnServerlessCacheProps.getEngine()
CfnServerlessCacheProps.Builder	finalSnapshotName(String finalSnapshotName)	Sets the value of CfnServerlessCacheProps.getFinalSnapshotName()
CfnServerlessCacheProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnServerlessCacheProps.getKmsKeyId()
CfnServerlessCacheProps.Builder	majorEngineVersion(String majorEngineVersion)	Sets the value of CfnServerlessCacheProps.getMajorEngineVersion()
CfnServerlessCacheProps.Builder	readerEndpoint(IResolvable readerEndpoint)	Sets the value of CfnServerlessCacheProps.getReaderEndpoint()
CfnServerlessCacheProps.Builder	readerEndpoint(CfnServerlessCache.EndpointProperty readerEndpoint)	Sets the value of CfnServerlessCacheProps.getReaderEndpoint()
CfnServerlessCacheProps.Builder	securityGroupIds(List<String> securityGroupIds)	Sets the value of CfnServerlessCacheProps.getSecurityGroupIds()
CfnServerlessCacheProps.Builder	serverlessCacheName(String serverlessCacheName)	Sets the value of CfnServerlessCacheProps.getServerlessCacheName()
CfnServerlessCacheProps.Builder	snapshotArnsToRestore(List<String> snapshotArnsToRestore)	Sets the value of CfnServerlessCacheProps.getSnapshotArnsToRestore()
CfnServerlessCacheProps.Builder	snapshotRetentionLimit(Number snapshotRetentionLimit)	Sets the value of CfnServerlessCacheProps.getSnapshotRetentionLimit()
CfnServerlessCacheProps.Builder	subnetIds(List<String> subnetIds)	Sets the value of CfnServerlessCacheProps.getSubnetIds()
CfnServerlessCacheProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnServerlessCacheProps.getTags()
CfnServerlessCacheProps.Builder	userGroupId(String userGroupId)	Sets the value of CfnServerlessCacheProps.getUserGroupId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

engine

@Stability(Stable)
public CfnServerlessCacheProps.Builder engine(String engine)

Sets the value of CfnServerlessCacheProps.getEngine()

Parameters:

engine - The engine the serverless cache is compatible with. This parameter is required.

Returns:

this

serverlessCacheName

@Stability(Stable)
public CfnServerlessCacheProps.Builder serverlessCacheName(String serverlessCacheName)

Sets the value of CfnServerlessCacheProps.getServerlessCacheName()

Parameters:

serverlessCacheName - The unique identifier of the serverless cache. This parameter is required.

Returns:

this

cacheUsageLimits

@Stability(Stable)
public CfnServerlessCacheProps.Builder cacheUsageLimits(IResolvable cacheUsageLimits)

Sets the value of CfnServerlessCacheProps.getCacheUsageLimits()

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache.

Returns:

this

cacheUsageLimits

@Stability(Stable)
public CfnServerlessCacheProps.Builder cacheUsageLimits(CfnServerlessCache.CacheUsageLimitsProperty cacheUsageLimits)

Sets the value of CfnServerlessCacheProps.getCacheUsageLimits()

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache.

Returns:

this

dailySnapshotTime

@Stability(Stable)
public CfnServerlessCacheProps.Builder dailySnapshotTime(String dailySnapshotTime)

Sets the value of CfnServerlessCacheProps.getDailySnapshotTime()

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:

this

description

@Stability(Stable)
public CfnServerlessCacheProps.Builder description(String description)

Sets the value of CfnServerlessCacheProps.getDescription()

Parameters:

description - A description of the serverless cache.

Returns:

this

endpoint

@Stability(Stable)
public CfnServerlessCacheProps.Builder endpoint(IResolvable endpoint)

Sets the value of CfnServerlessCacheProps.getEndpoint()

Parameters:

endpoint - Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

this

endpoint

@Stability(Stable)
public CfnServerlessCacheProps.Builder endpoint(CfnServerlessCache.EndpointProperty endpoint)

Sets the value of CfnServerlessCacheProps.getEndpoint()

Parameters:

endpoint - Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

this

finalSnapshotName

@Stability(Stable)
public CfnServerlessCacheProps.Builder finalSnapshotName(String finalSnapshotName)

Sets the value of CfnServerlessCacheProps.getFinalSnapshotName()

Parameters:

finalSnapshotName - The name of the final snapshot taken of a cache before the cache is deleted.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnServerlessCacheProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnServerlessCacheProps.getKmsKeyId()

Parameters:

kmsKeyId - The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

Returns:

this

majorEngineVersion

@Stability(Stable)
public CfnServerlessCacheProps.Builder majorEngineVersion(String majorEngineVersion)

Sets the value of CfnServerlessCacheProps.getMajorEngineVersion()

Parameters:

majorEngineVersion - The version number of the engine the serverless cache is compatible with.

Returns:

this

readerEndpoint

@Stability(Stable)
public CfnServerlessCacheProps.Builder readerEndpoint(IResolvable readerEndpoint)

Sets the value of CfnServerlessCacheProps.getReaderEndpoint()

Parameters:

readerEndpoint - Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

this

readerEndpoint

@Stability(Stable)
public CfnServerlessCacheProps.Builder readerEndpoint(CfnServerlessCache.EndpointProperty readerEndpoint)

Sets the value of CfnServerlessCacheProps.getReaderEndpoint()

Parameters:

readerEndpoint - Represents the information required for client programs to connect to a cache node. This value is read-only.

Returns:

this

securityGroupIds

@Stability(Stable)
public CfnServerlessCacheProps.Builder securityGroupIds(List<String> securityGroupIds)

Sets the value of CfnServerlessCacheProps.getSecurityGroupIds()

Parameters:

securityGroupIds - The IDs of the EC2 security groups associated with the serverless cache.

Returns:

this

snapshotArnsToRestore

@Stability(Stable)
public CfnServerlessCacheProps.Builder snapshotArnsToRestore(List<String> snapshotArnsToRestore)

Sets the value of CfnServerlessCacheProps.getSnapshotArnsToRestore()

Parameters:

snapshotArnsToRestore - The ARN of the snapshot from which to restore data into the new cache.

Returns:

this

snapshotRetentionLimit

@Stability(Stable)
public CfnServerlessCacheProps.Builder snapshotRetentionLimit(Number snapshotRetentionLimit)

Sets the value of CfnServerlessCacheProps.getSnapshotRetentionLimit()

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:

this

subnetIds

@Stability(Stable)
public CfnServerlessCacheProps.Builder subnetIds(List<String> subnetIds)

Sets the value of CfnServerlessCacheProps.getSubnetIds()

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:

this

tags

@Stability(Stable)
public CfnServerlessCacheProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnServerlessCacheProps.getTags()

Parameters:

tags - A list of tags to be added to this resource.

Returns:

this

userGroupId

@Stability(Stable)
public CfnServerlessCacheProps.Builder userGroupId(String userGroupId)

Sets the value of CfnServerlessCacheProps.getUserGroupId()

Parameters:

userGroupId - The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

Returns:

this

build

@Stability(Stable)
public CfnServerlessCacheProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnServerlessCacheProps>

Returns:

a new instance of CfnServerlessCacheProps

Throws:

NullPointerException - if any required attribute was not provided