Package software.amazon.awscdk.cfnpropertymixins.services.elasticache

Class CfnServerlessCacheMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticache.CfnServerlessCacheMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServerlessCacheMixinProps>

Enclosing interface:

CfnServerlessCacheMixinProps

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

A builder for CfnServerlessCacheMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

cacheUsageLimits

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

Sets the value of CfnServerlessCacheMixinProps.getCacheUsageLimits()

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache.

Returns:

this

cacheUsageLimits

@Stability(Stable)
public CfnServerlessCacheMixinProps.Builder cacheUsageLimits(CfnServerlessCachePropsMixin.CacheUsageLimitsProperty cacheUsageLimits)

Sets the value of CfnServerlessCacheMixinProps.getCacheUsageLimits()

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache.

Returns:

this

dailySnapshotTime

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

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder description(String description)

Sets the value of CfnServerlessCacheMixinProps.getDescription()

Parameters:

description - A description of the serverless cache.

Returns:

this

endpoint

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

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder endpoint(CfnServerlessCachePropsMixin.EndpointProperty endpoint)

Sets the value of CfnServerlessCacheMixinProps.getEndpoint()

Parameters:

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

Returns:

this

engine

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

Sets the value of CfnServerlessCacheMixinProps.getEngine()

Parameters:

engine - The engine the serverless cache is compatible with.

Returns:

this

finalSnapshotName

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

Sets the value of CfnServerlessCacheMixinProps.getFinalSnapshotName()

Parameters:

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

Returns:

this

kmsKeyId

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

Sets the value of CfnServerlessCacheMixinProps.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

kmsKeyId

@Stability(Stable)
public CfnServerlessCacheMixinProps.Builder kmsKeyId(IKeyRef kmsKeyId)

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder majorEngineVersion(String majorEngineVersion)

Sets the value of CfnServerlessCacheMixinProps.getMajorEngineVersion()

Parameters:

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

Returns:

this

readerEndpoint

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

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder readerEndpoint(CfnServerlessCachePropsMixin.EndpointProperty readerEndpoint)

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder securityGroupIds(List<? extends Object> securityGroupIds)

Sets the value of CfnServerlessCacheMixinProps.getSecurityGroupIds()

Parameters:

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

Returns:

this

serverlessCacheName

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

Sets the value of CfnServerlessCacheMixinProps.getServerlessCacheName()

Parameters:

serverlessCacheName - The unique identifier of the serverless cache.

Returns:

this

snapshotArnsToRestore

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

Sets the value of CfnServerlessCacheMixinProps.getSnapshotArnsToRestore()

Parameters:

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

Returns:

this

snapshotRetentionLimit

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

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder subnetIds(List<? extends Object> subnetIds)

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnServerlessCacheMixinProps.getTags()

Parameters:

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

Returns:

this

userGroupId

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

Sets the value of CfnServerlessCacheMixinProps.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

userGroupId

@Stability(Stable)
public CfnServerlessCacheMixinProps.Builder userGroupId(IUserGroupRef userGroupId)

Sets the value of CfnServerlessCacheMixinProps.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 CfnServerlessCacheMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnServerlessCacheMixinProps

Throws:

NullPointerException - if any required attribute was not provided