Package software.amazon.awsconstructs.services.lambdaopensearch

Class LambdaToOpenSearchProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.lambdaopensearch.LambdaToOpenSearchProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaToOpenSearchProps>

Enclosing interface:

LambdaToOpenSearchProps

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

A builder for LambdaToOpenSearchProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaToOpenSearchProps	build()	Builds the configured instance.
LambdaToOpenSearchProps.Builder	cognitoDomainName(String cognitoDomainName)	Sets the value of LambdaToOpenSearchProps.getCognitoDomainName()
LambdaToOpenSearchProps.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms)	Sets the value of LambdaToOpenSearchProps.getCreateCloudWatchAlarms()
LambdaToOpenSearchProps.Builder	deployVpc(Boolean deployVpc)	Sets the value of LambdaToOpenSearchProps.getDeployVpc()
LambdaToOpenSearchProps.Builder	domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName)	Sets the value of LambdaToOpenSearchProps.getDomainEndpointEnvironmentVariableName()
LambdaToOpenSearchProps.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)	Sets the value of LambdaToOpenSearchProps.getExistingLambdaObj()
LambdaToOpenSearchProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)	Sets the value of LambdaToOpenSearchProps.getExistingVpc()
LambdaToOpenSearchProps.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)	Sets the value of LambdaToOpenSearchProps.getLambdaFunctionProps()
LambdaToOpenSearchProps.Builder	openSearchDomainName(String openSearchDomainName)	Sets the value of LambdaToOpenSearchProps.getOpenSearchDomainName()
LambdaToOpenSearchProps.Builder	openSearchDomainProps(software.amazon.awscdk.services.opensearchservice.CfnDomainProps openSearchDomainProps)	Sets the value of LambdaToOpenSearchProps.getOpenSearchDomainProps()
LambdaToOpenSearchProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)	Sets the value of LambdaToOpenSearchProps.getVpcProps()

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

openSearchDomainName

public LambdaToOpenSearchProps.Builder openSearchDomainName(String openSearchDomainName)

Sets the value of LambdaToOpenSearchProps.getOpenSearchDomainName()

Parameters:

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

Returns:

this

cognitoDomainName

public LambdaToOpenSearchProps.Builder cognitoDomainName(String cognitoDomainName)

Sets the value of LambdaToOpenSearchProps.getCognitoDomainName()

Parameters:

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

Returns:

this

createCloudWatchAlarms

public LambdaToOpenSearchProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Sets the value of LambdaToOpenSearchProps.getCreateCloudWatchAlarms()

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.

Returns:

this

deployVpc

public LambdaToOpenSearchProps.Builder deployVpc(Boolean deployVpc)

Sets the value of LambdaToOpenSearchProps.getDeployVpc()

Parameters:

deployVpc - Whether to deploy a new VPC.

Returns:

this

domainEndpointEnvironmentVariableName

public LambdaToOpenSearchProps.Builder domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName)

Sets the value of LambdaToOpenSearchProps.getDomainEndpointEnvironmentVariableName()

Parameters:

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

Returns:

this

existingLambdaObj

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

Sets the value of LambdaToOpenSearchProps.getExistingLambdaObj()

Parameters:

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

Returns:

this

existingVpc

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

Sets the value of LambdaToOpenSearchProps.getExistingVpc()

Parameters:

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

Returns:

this

lambdaFunctionProps

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

Sets the value of LambdaToOpenSearchProps.getLambdaFunctionProps()

Parameters:

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

Returns:

this

openSearchDomainProps

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

Sets the value of LambdaToOpenSearchProps.getOpenSearchDomainProps()

Parameters:

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

Returns:

this

vpcProps

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

Sets the value of LambdaToOpenSearchProps.getVpcProps()

Parameters:

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

Returns:

this

build

public LambdaToOpenSearchProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaToOpenSearchProps

Throws:

NullPointerException - if any required attribute was not provided