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

Class CfnServerlessCachePropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServerlessCachePropsMixin>

Enclosing class:

CfnServerlessCachePropsMixin

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

A fluent builder for CfnServerlessCachePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnServerlessCachePropsMixin	build()
CfnServerlessCachePropsMixin.Builder	cacheUsageLimits(CfnServerlessCachePropsMixin.CacheUsageLimitsProperty cacheUsageLimits)	The cache usage limit for the serverless cache.
CfnServerlessCachePropsMixin.Builder	cacheUsageLimits(IResolvable cacheUsageLimits)	The cache usage limit for the serverless cache.
static CfnServerlessCachePropsMixin.Builder	create()
static CfnServerlessCachePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnServerlessCachePropsMixin.Builder	dailySnapshotTime(String dailySnapshotTime)	The daily time that a cache snapshot will be created.
CfnServerlessCachePropsMixin.Builder	description(String description)	A description of the serverless cache.
CfnServerlessCachePropsMixin.Builder	endpoint(CfnServerlessCachePropsMixin.EndpointProperty endpoint)	Represents the information required for client programs to connect to a cache node.
CfnServerlessCachePropsMixin.Builder	endpoint(IResolvable endpoint)	Represents the information required for client programs to connect to a cache node.
CfnServerlessCachePropsMixin.Builder	engine(String engine)	The engine the serverless cache is compatible with.
CfnServerlessCachePropsMixin.Builder	finalSnapshotName(String finalSnapshotName)	The name of the final snapshot taken of a cache before the cache is deleted.
CfnServerlessCachePropsMixin.Builder	kmsKeyId(String kmsKeyId)	The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
CfnServerlessCachePropsMixin.Builder	kmsKeyId(IKeyRef kmsKeyId)	The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
CfnServerlessCachePropsMixin.Builder	majorEngineVersion(String majorEngineVersion)	The version number of the engine the serverless cache is compatible with.
CfnServerlessCachePropsMixin.Builder	readerEndpoint(CfnServerlessCachePropsMixin.EndpointProperty readerEndpoint)	Represents the information required for client programs to connect to a cache node.
CfnServerlessCachePropsMixin.Builder	readerEndpoint(IResolvable readerEndpoint)	Represents the information required for client programs to connect to a cache node.
CfnServerlessCachePropsMixin.Builder	securityGroupIds(List<? extends Object> securityGroupIds)	The IDs of the EC2 security groups associated with the serverless cache.
CfnServerlessCachePropsMixin.Builder	serverlessCacheName(String serverlessCacheName)	The unique identifier of the serverless cache.
CfnServerlessCachePropsMixin.Builder	snapshotArnsToRestore(List<String> snapshotArnsToRestore)	The ARN of the snapshot from which to restore data into the new cache.
CfnServerlessCachePropsMixin.Builder	snapshotRetentionLimit(Number snapshotRetentionLimit)	The current setting for the number of serverless cache snapshots the system will retain.
CfnServerlessCachePropsMixin.Builder	subnetIds(List<? extends Object> 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.
CfnServerlessCachePropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of tags to be added to this resource.
CfnServerlessCachePropsMixin.Builder	userGroupId(String userGroupId)	The identifier of the user group associated with the serverless cache.
CfnServerlessCachePropsMixin.Builder	userGroupId(IUserGroupRef userGroupId)	The identifier of the user group associated with the serverless cache.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnServerlessCachePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnServerlessCachePropsMixin.Builder.

create

@Stability(Stable)
public static CfnServerlessCachePropsMixin.Builder create()

Returns:

a new instance of CfnServerlessCachePropsMixin.Builder.

cacheUsageLimits

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

The cache usage limit for the serverless cache.

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-cacheusagelimits

cacheUsageLimits

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

The cache usage limit for the serverless cache.

Parameters:

cacheUsageLimits - The cache usage limit for the serverless cache. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-cacheusagelimits

dailySnapshotTime

@Stability(Stable)
public CfnServerlessCachePropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-dailysnapshottime

description

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

A description of the serverless cache.

Parameters:

description - A description of the serverless cache. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-description

endpoint

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

Represents the information required for client programs to connect to a cache node.

This value is read-only.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-endpoint

endpoint

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder endpoint(CfnServerlessCachePropsMixin.EndpointProperty endpoint)

Represents the information required for client programs to connect to a cache node.

This value is read-only.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-endpoint

engine

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

The engine the serverless cache is compatible with.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-engine

finalSnapshotName

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-finalsnapshotname

kmsKeyId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-kmskeyid

kmsKeyId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-kmskeyid

majorEngineVersion

@Stability(Stable)
public CfnServerlessCachePropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-majorengineversion

readerEndpoint

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

Represents the information required for client programs to connect to a cache node.

This value is read-only.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-readerendpoint

readerEndpoint

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder readerEndpoint(CfnServerlessCachePropsMixin.EndpointProperty readerEndpoint)

Represents the information required for client programs to connect to a cache node.

This value is read-only.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-readerendpoint

securityGroupIds

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder securityGroupIds(List<? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-securitygroupids

serverlessCacheName

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

The unique identifier of the serverless cache.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-serverlesscachename

snapshotArnsToRestore

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotarnstorestore

snapshotRetentionLimit

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder snapshotRetentionLimit(Number 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotretentionlimit

subnetIds

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder subnetIds(List<? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-subnetids

tags

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

A list of tags to be added to this resource.

Parameters:

tags - A list of tags to be added to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-tags

userGroupId

@Stability(Stable)
public CfnServerlessCachePropsMixin.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-usergroupid

userGroupId

@Stability(Stable)
public CfnServerlessCachePropsMixin.Builder userGroupId(IUserGroupRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-usergroupid

build

@Stability(Stable)
public CfnServerlessCachePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnServerlessCachePropsMixin.