software.amazon.awsconstructs.services.lambdaelasticachememcached

Interface LambdaToElasticachememcachedProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaToElasticachememcachedProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-03-23T16:43:36.932Z")
public interface LambdaToElasticachememcachedProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LambdaToElasticachememcachedProps.Builder A builder for LambdaToElasticachememcachedProps
static class	LambdaToElasticachememcachedProps.Jsii$Proxy An implementation for LambdaToElasticachememcachedProps

Method Summary

Modifier and Type	Method and Description
static LambdaToElasticachememcachedProps.Builder	builder()
default String	getCacheEndpointEnvironmentVariableName() Optional Name for the Lambda function environment variable set to the cache endpoint.
default Object	getCacheProps() Optional user provided props to override the default props for the Elasticache cache.
default software.amazon.awscdk.services.elasticache.CfnCacheCluster	getExistingCache() Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error.
default software.amazon.awscdk.services.lambda.Function	getExistingLambdaObj() Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
default software.amazon.awscdk.services.ec2.IVpc	getExistingVpc() An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
default software.amazon.awscdk.services.lambda.FunctionProps	getLambdaFunctionProps() Optional user provided props to override the default props for the Lambda function.
default software.amazon.awscdk.services.ec2.VpcProps	getVpcProps() Properties to override default properties if deployVpc is true.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCacheEndpointEnvironmentVariableName

@Nullable
default String getCacheEndpointEnvironmentVariableName()

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

Default: - CACHE_ENDPOINT

getCacheProps

@Nullable
default Object getCacheProps()

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)

getExistingCache

@Nullable
default software.amazon.awscdk.services.elasticache.CfnCacheCluster getExistingCache()

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

Default: - none

getExistingLambdaObj

@Nullable
default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()

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

Default: - None

getExistingVpc

@Nullable
default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()

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

Default: - none

getLambdaFunctionProps

@Nullable
default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()

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

Default: - Default properties are used.

getVpcProps

@Nullable
default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()

Properties to override default properties if deployVpc is true.

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

builder

static LambdaToElasticachememcachedProps.Builder builder()

Returns:

a LambdaToElasticachememcachedProps.Builder of LambdaToElasticachememcachedProps