software.amazon.awsconstructs.services.lambdaelasticachememcached

Class LambdaToElasticachememcached.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdaelasticachememcached.LambdaToElasticachememcached.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToElasticachememcached>

Enclosing class:

LambdaToElasticachememcached

public static final class LambdaToElasticachememcached.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaToElasticachememcached>

A fluent builder for LambdaToElasticachememcached.

Method Summary

Modifier and Type	Method and Description
LambdaToElasticachememcached	build()
LambdaToElasticachememcached.Builder	cacheEndpointEnvironmentVariableName(String cacheEndpointEnvironmentVariableName) Optional Name for the Lambda function environment variable set to the cache endpoint.
LambdaToElasticachememcached.Builder	cacheProps(Object cacheProps) Optional user provided props to override the default props for the Elasticache cache.
static LambdaToElasticachememcached.Builder	create(software.constructs.Construct scope, String id)
LambdaToElasticachememcached.Builder	existingCache(software.amazon.awscdk.services.elasticache.CfnCacheCluster existingCache) Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error.
LambdaToElasticachememcached.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToElasticachememcached.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
LambdaToElasticachememcached.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Optional user provided props to override the default props for the Lambda function.
LambdaToElasticachememcached.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Properties to override default properties if deployVpc is true.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LambdaToElasticachememcached.Builder create(software.constructs.Construct scope,
                                                          String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of LambdaToElasticachememcached.Builder.

cacheEndpointEnvironmentVariableName

public LambdaToElasticachememcached.Builder cacheEndpointEnvironmentVariableName(String cacheEndpointEnvironmentVariableName)

Optional Name for the Lambda function environment variable set to the cache endpoint.

Default: - CACHE_ENDPOINT

Parameters:

cacheEndpointEnvironmentVariableName - Optional Name for the Lambda function environment variable set to the cache endpoint. This parameter is required.

Returns:

this

cacheProps

public LambdaToElasticachememcached.Builder cacheProps(Object cacheProps)

Optional user provided props to override the default props for the Elasticache cache.

Providing both this and existingCache will cause an error. If you provide this, you must provide the associated VPC in existingVpc.

Default: - Default properties are used (core/lib/elasticacahe-defaults.ts)

Parameters:

cacheProps - Optional user provided props to override the default props for the Elasticache cache. This parameter is required.

Returns:

this

existingCache

public LambdaToElasticachememcached.Builder existingCache(software.amazon.awscdk.services.elasticache.CfnCacheCluster existingCache)

Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error.

Default: - none

Parameters:

existingCache - Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error. This parameter is required.

Returns:

this

existingLambdaObj

public LambdaToElasticachememcached.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error. This parameter is required.

Returns:

this

existingVpc

public LambdaToElasticachememcached.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

An existing VPC for the construct to use (construct will NOT create a new VPC in this case).

Default: - none

Parameters:

existingVpc - An existing VPC for the construct to use (construct will NOT create a new VPC in this case). This parameter is required.

Returns:

this

lambdaFunctionProps

public LambdaToElasticachememcached.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

Optional user provided props to override the default props for the Lambda function.

Default: - Default properties are used.

Parameters:

lambdaFunctionProps - Optional user provided props to override the default props for the Lambda function. This parameter is required.

Returns:

this

vpcProps

public LambdaToElasticachememcached.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Properties to override default properties if deployVpc is true.

Default: - DefaultIsolatedVpcProps() in vpc-defaults.ts

Parameters:

vpcProps - Properties to override default properties if deployVpc is true. This parameter is required.

Returns:

this

build

public LambdaToElasticachememcached build()

Specified by:

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