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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.cognitoDomainName(String cognitoDomainName) Sets the value ofLambdaToOpenSearchProps.getCognitoDomainName()createCloudWatchAlarms(Boolean createCloudWatchAlarms) Sets the value ofLambdaToOpenSearchProps.getCreateCloudWatchAlarms()Sets the value ofLambdaToOpenSearchProps.getDeployVpc()domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName) Sets the value ofLambdaToOpenSearchProps.getDomainEndpointEnvironmentVariableName()existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Sets the value ofLambdaToOpenSearchProps.getExistingLambdaObj()existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) Sets the value ofLambdaToOpenSearchProps.getExistingVpc()lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Sets the value ofLambdaToOpenSearchProps.getLambdaFunctionProps()openSearchDomainName(String openSearchDomainName) Sets the value ofLambdaToOpenSearchProps.getOpenSearchDomainName()openSearchDomainProps(software.amazon.awscdk.services.opensearchservice.CfnDomainProps openSearchDomainProps) Sets the value ofLambdaToOpenSearchProps.getOpenSearchDomainProps()vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Sets the value ofLambdaToOpenSearchProps.getVpcProps()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
openSearchDomainName
Sets the value ofLambdaToOpenSearchProps.getOpenSearchDomainName()- Parameters:
openSearchDomainName- Domain name for the OpenSearch Service. This parameter is required.- Returns:
this
-
cognitoDomainName
Sets the value ofLambdaToOpenSearchProps.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
Sets the value ofLambdaToOpenSearchProps.getCreateCloudWatchAlarms()- Parameters:
createCloudWatchAlarms- Whether to create recommended CloudWatch alarms.- Returns:
this
-
deployVpc
Sets the value ofLambdaToOpenSearchProps.getDeployVpc()- Parameters:
deployVpc- Whether to deploy a new VPC.- Returns:
this
-
domainEndpointEnvironmentVariableName
public LambdaToOpenSearchProps.Builder domainEndpointEnvironmentVariableName(String domainEndpointEnvironmentVariableName) Sets the value ofLambdaToOpenSearchProps.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 ofLambdaToOpenSearchProps.getExistingLambdaObj()- Parameters:
existingLambdaObj- Existing instance of Lambda Function object, providing both this andlambdaFunctionPropswill cause an error.- Returns:
this
-
existingVpc
public LambdaToOpenSearchProps.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) Sets the value ofLambdaToOpenSearchProps.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 ofLambdaToOpenSearchProps.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 ofLambdaToOpenSearchProps.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 ofLambdaToOpenSearchProps.getVpcProps()- Parameters:
vpcProps- Properties to override default properties if deployVpc is true.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<LambdaToOpenSearchProps>- Returns:
- a new instance of
LambdaToOpenSearchProps - Throws:
NullPointerException- if any required attribute was not provided
-