Package software.amazon.awscdk.services.s3

Interface CfnBucket.LambdaConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.LambdaConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.LambdaConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the AWS Lambda functions to invoke and the events for which to invoke them.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 LambdaConfigurationProperty lambdaConfigurationProperty = LambdaConfigurationProperty.builder()
         .event("event")
         .function("function")
         // the properties below are optional
         .filter(NotificationFilterProperty.builder()
                 .s3Key(S3KeyFilterProperty.builder()
                         .rules(List.of(FilterRuleProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucket.LambdaConfigurationProperty.Builder	builder()
String	getEvent()	The Amazon S3 bucket event for which to invoke the AWS Lambda function.
default Object	getFilter()	The filtering rules that determine which objects invoke the AWS Lambda function.
String	getFunction()	The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEvent

@Stability(Stable)
@NotNull
String getEvent()

The Amazon S3 bucket event for which to invoke the AWS Lambda function.

For more information, see Supported Event Types in the Amazon S3 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-event

getFunction

@Stability(Stable)
@NotNull
String getFunction()

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-function

getFilter

@Stability(Stable)
@Nullable
default Object getFilter()

The filtering rules that determine which objects invoke the AWS Lambda function.

For example, you can create a filter so that only image files with a .jpg extension invoke the function when they are added to the Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lambdaconfiguration.html#cfn-s3-bucket-lambdaconfiguration-filter

builder

@Stability(Stable)
static CfnBucket.LambdaConfigurationProperty.Builder builder()

Returns:

a CfnBucket.LambdaConfigurationProperty.Builder of CfnBucket.LambdaConfigurationProperty