Package software.amazon.awsconstructs.services.lambdaeventbridge

Interface LambdaToEventbridgeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LambdaToEventbridgeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-06T01:58:42.204Z") public interface LambdaToEventbridgeProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    LambdaToEventbridgeProps.Builder
    A builder for LambdaToEventbridgeProps
    static final class 
    LambdaToEventbridgeProps.Jsii$Proxy
    An implementation for LambdaToEventbridgeProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static LambdaToEventbridgeProps.Builder
    builder()
     
    default Boolean
    getDeployVpc()
    Whether to deploy a new VPC.
    default String
    getEventBusEnvironmentVariableName()
    Optional Name for the Lambda function environment variable set to the name of the Event bus.
    default software.amazon.awscdk.services.events.EventBusProps
    getEventBusProps()
    A new custom EventBus is created with provided props.
    default software.amazon.awscdk.services.events.IEventBus
    getExistingEventBusInterface()
    Existing instance of a custom EventBus.
    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.
    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 Details

    • getDeployVpc

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

      Default: - false

    • getEventBusEnvironmentVariableName

      @Nullable default String getEventBusEnvironmentVariableName()
      Optional Name for the Lambda function environment variable set to the name of the Event bus.

      Default: - EVENTBUS_NAME

    • getEventBusProps

      @Nullable default software.amazon.awscdk.services.events.EventBusProps getEventBusProps()
      A new custom EventBus is created with provided props.

      Default: - None

    • getExistingEventBusInterface

      @Nullable default software.amazon.awscdk.services.events.IEventBus getExistingEventBusInterface()
      Existing instance of a custom EventBus.

      Default: - None

    • 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).

    • getLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()
      User provided props to override the default props for the Lambda function.

      Default: - Default properties are used.

    • getVpcProps

      @Nullable default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()
      Properties to override default properties if deployVpc is true.

    • builder

      static LambdaToEventbridgeProps.Builder builder()
      Returns:
      a LambdaToEventbridgeProps.Builder of LambdaToEventbridgeProps