Package software.amazon.awsconstructs.services.lambdaopensearch

Interface LambdaToOpenSearchProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LambdaToOpenSearchProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.111.0 (build cc021d6)", date="2025-09-10T20:22:00.221Z") public interface LambdaToOpenSearchProps extends software.amazon.jsii.JsiiSerializable

  • Method Details

    • getOpenSearchDomainName

      @NotNull String getOpenSearchDomainName()
      Domain name for the OpenSearch Service.

      Default: - None

    • getCognitoDomainName

      @Nullable default String getCognitoDomainName()
      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

    • getCreateCloudWatchAlarms

      @Nullable default Boolean getCreateCloudWatchAlarms()
      Whether to create recommended CloudWatch alarms.

      Default: - Alarms are created

    • getDeployVpc

      @Nullable default Boolean getDeployVpc()
      Whether to deploy a new VPC.

      Default: - false

    • getDomainEndpointEnvironmentVariableName

      @Nullable default String getDomainEndpointEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the domain endpoint.

      Default: - DOMAIN_ENDPOINT

    • 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()
      User provided props to override the default props for the Lambda function.

      Default: - Default props are used

    • getOpenSearchDomainProps

      @Nullable default software.amazon.awscdk.services.opensearchservice.CfnDomainProps getOpenSearchDomainProps()
      Optional user provided props to override the default props for the OpenSearch Service.

      Default: - Default props 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 LambdaToOpenSearchProps.Builder builder()
      Returns:
      a LambdaToOpenSearchProps.Builder of LambdaToOpenSearchProps