software.amazon.awsconstructs.services.lambdaopensearch

Class LambdaToOpenSearch.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdaopensearch.LambdaToOpenSearch.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToOpenSearch>

Enclosing class:

LambdaToOpenSearch

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

A fluent builder for LambdaToOpenSearch.

Method Summary

Modifier and Type	Method and Description
LambdaToOpenSearch	build()
LambdaToOpenSearch.Builder	cognitoDomainName(String cognitoDomainName) Optional Amazon Cognito domain name.
static LambdaToOpenSearch.Builder	create(software.constructs.Construct scope, String id)
LambdaToOpenSearch.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms) Whether to create recommended CloudWatch alarms.
LambdaToOpenSearch.Builder	deployVpc(Boolean deployVpc) Whether to deploy a new VPC.
LambdaToOpenSearch.Builder	domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName) Optional Name for the Lambda function environment variable set to the domain endpoint.
LambdaToOpenSearch.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.
LambdaToOpenSearch.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).
LambdaToOpenSearch.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) User provided props to override the default props for the Lambda function.
LambdaToOpenSearch.Builder	openSearchDomainName(String openSearchDomainName) Domain name for the OpenSearch Service.
LambdaToOpenSearch.Builder	openSearchDomainProps(software.amazon.awscdk.services.opensearchservice.CfnDomainProps openSearchDomainProps) Optional user provided props to override the default props for the OpenSearch Service.
LambdaToOpenSearch.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 LambdaToOpenSearch.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 LambdaToOpenSearch.Builder.

openSearchDomainName

public LambdaToOpenSearch.Builder openSearchDomainName(String openSearchDomainName)

Domain name for the OpenSearch Service.

Default: - None

Parameters:

openSearchDomainName - Domain name for the OpenSearch Service. This parameter is required.

Returns:

this

cognitoDomainName

public LambdaToOpenSearch.Builder cognitoDomainName(String cognitoDomainName)

Optional Amazon Cognito domain name.

If omitted the Amazon Cognito domain will default to the OpenSearch Service domain name.

Default: - the OpenSearch Service domain name

Parameters:

cognitoDomainName - Optional Amazon Cognito domain name. This parameter is required.

Returns:

this

createCloudWatchAlarms

public LambdaToOpenSearch.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Whether to create recommended CloudWatch alarms.

Default: - Alarms are created

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms. This parameter is required.

Returns:

this

deployVpc

public LambdaToOpenSearch.Builder deployVpc(Boolean deployVpc)

Whether to deploy a new VPC.

Default: - false

Parameters:

deployVpc - Whether to deploy a new VPC. This parameter is required.

Returns:

this

domainEndpointEnvironmentVariableName

public LambdaToOpenSearch.Builder domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName)

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

Default: - DOMAIN_ENDPOINT

Parameters:

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

Returns:

this

existingLambdaObj

public LambdaToOpenSearch.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 LambdaToOpenSearch.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 LambdaToOpenSearch.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

User provided props to override the default props for the Lambda function.

Default: - Default props are used

Parameters:

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

Returns:

this

openSearchDomainProps

public LambdaToOpenSearch.Builder openSearchDomainProps(software.amazon.awscdk.services.opensearchservice.CfnDomainProps openSearchDomainProps)

Optional user provided props to override the default props for the OpenSearch Service.

Default: - Default props are used

Parameters:

openSearchDomainProps - Optional user provided props to override the default props for the OpenSearch Service. This parameter is required.

Returns:

this

vpcProps

public LambdaToOpenSearch.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 LambdaToOpenSearch build()

Specified by:

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