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.74.0 (build 6d08790)",
           date="2023-02-14T14:04:21.455Z")
public interface LambdaToOpenSearchProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static LambdaToOpenSearchProps.Builder	builder()
default String	getCognitoDomainName() Optional Amazon Cognito domain name.
default Boolean	getCreateCloudWatchAlarms() Whether to create recommended CloudWatch alarms.
default Boolean	getDeployVpc() Whether to deploy a new VPC.
default String	getDomainEndpointEnvironmentVariableName() Optional Name for the Lambda function environment variable set to the domain endpoint.
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() User provided props to override the default props for the Lambda function.
String	getOpenSearchDomainName() Domain name for the OpenSearch Service.
default software.amazon.awscdk.services.opensearchservice.CfnDomainProps	getOpenSearchDomainProps() Optional user provided props to override the default props for the OpenSearch Service.
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

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