software.amazon.awssdk.services.lambda.model.EventSourceMappingConfiguration Maven / Gradle / Ivy
Show all versions of lambda Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.lambda.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A mapping between an Amazon Web Services resource and a Lambda function. For details, see
* CreateEventSourceMapping.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EventSourceMappingConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField UUID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("UUID")
.getter(getter(EventSourceMappingConfiguration::uuid)).setter(setter(Builder::uuid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UUID").build()).build();
private static final SdkField STARTING_POSITION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StartingPosition").getter(getter(EventSourceMappingConfiguration::startingPositionAsString))
.setter(setter(Builder::startingPosition))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartingPosition").build()).build();
private static final SdkField STARTING_POSITION_TIMESTAMP_FIELD = SdkField
. builder(MarshallingType.INSTANT).memberName("StartingPositionTimestamp")
.getter(getter(EventSourceMappingConfiguration::startingPositionTimestamp))
.setter(setter(Builder::startingPositionTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartingPositionTimestamp").build())
.build();
private static final SdkField BATCH_SIZE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("BatchSize").getter(getter(EventSourceMappingConfiguration::batchSize))
.setter(setter(Builder::batchSize))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BatchSize").build()).build();
private static final SdkField MAXIMUM_BATCHING_WINDOW_IN_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaximumBatchingWindowInSeconds")
.getter(getter(EventSourceMappingConfiguration::maximumBatchingWindowInSeconds))
.setter(setter(Builder::maximumBatchingWindowInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaximumBatchingWindowInSeconds")
.build()).build();
private static final SdkField PARALLELIZATION_FACTOR_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ParallelizationFactor").getter(getter(EventSourceMappingConfiguration::parallelizationFactor))
.setter(setter(Builder::parallelizationFactor))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParallelizationFactor").build())
.build();
private static final SdkField EVENT_SOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EventSourceArn").getter(getter(EventSourceMappingConfiguration::eventSourceArn))
.setter(setter(Builder::eventSourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventSourceArn").build()).build();
private static final SdkField FILTER_CRITERIA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("FilterCriteria")
.getter(getter(EventSourceMappingConfiguration::filterCriteria)).setter(setter(Builder::filterCriteria))
.constructor(FilterCriteria::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FilterCriteria").build()).build();
private static final SdkField FUNCTION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FunctionArn").getter(getter(EventSourceMappingConfiguration::functionArn))
.setter(setter(Builder::functionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FunctionArn").build()).build();
private static final SdkField LAST_MODIFIED_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModified").getter(getter(EventSourceMappingConfiguration::lastModified))
.setter(setter(Builder::lastModified))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModified").build()).build();
private static final SdkField LAST_PROCESSING_RESULT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastProcessingResult").getter(getter(EventSourceMappingConfiguration::lastProcessingResult))
.setter(setter(Builder::lastProcessingResult))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastProcessingResult").build())
.build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(EventSourceMappingConfiguration::state)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField STATE_TRANSITION_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StateTransitionReason").getter(getter(EventSourceMappingConfiguration::stateTransitionReason))
.setter(setter(Builder::stateTransitionReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StateTransitionReason").build())
.build();
private static final SdkField DESTINATION_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DestinationConfig")
.getter(getter(EventSourceMappingConfiguration::destinationConfig)).setter(setter(Builder::destinationConfig))
.constructor(DestinationConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DestinationConfig").build()).build();
private static final SdkField> TOPICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Topics")
.getter(getter(EventSourceMappingConfiguration::topics))
.setter(setter(Builder::topics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Topics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> QUEUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Queues")
.getter(getter(EventSourceMappingConfiguration::queues))
.setter(setter(Builder::queues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Queues").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SOURCE_ACCESS_CONFIGURATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SourceAccessConfigurations")
.getter(getter(EventSourceMappingConfiguration::sourceAccessConfigurations))
.setter(setter(Builder::sourceAccessConfigurations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceAccessConfigurations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SourceAccessConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SELF_MANAGED_EVENT_SOURCE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SelfManagedEventSource")
.getter(getter(EventSourceMappingConfiguration::selfManagedEventSource))
.setter(setter(Builder::selfManagedEventSource)).constructor(SelfManagedEventSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SelfManagedEventSource").build())
.build();
private static final SdkField MAXIMUM_RECORD_AGE_IN_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER).memberName("MaximumRecordAgeInSeconds")
.getter(getter(EventSourceMappingConfiguration::maximumRecordAgeInSeconds))
.setter(setter(Builder::maximumRecordAgeInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaximumRecordAgeInSeconds").build())
.build();
private static final SdkField BISECT_BATCH_ON_FUNCTION_ERROR_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BisectBatchOnFunctionError")
.getter(getter(EventSourceMappingConfiguration::bisectBatchOnFunctionError))
.setter(setter(Builder::bisectBatchOnFunctionError))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BisectBatchOnFunctionError").build())
.build();
private static final SdkField MAXIMUM_RETRY_ATTEMPTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaximumRetryAttempts").getter(getter(EventSourceMappingConfiguration::maximumRetryAttempts))
.setter(setter(Builder::maximumRetryAttempts))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaximumRetryAttempts").build())
.build();
private static final SdkField TUMBLING_WINDOW_IN_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TumblingWindowInSeconds").getter(getter(EventSourceMappingConfiguration::tumblingWindowInSeconds))
.setter(setter(Builder::tumblingWindowInSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TumblingWindowInSeconds").build())
.build();
private static final SdkField> FUNCTION_RESPONSE_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("FunctionResponseTypes")
.getter(getter(EventSourceMappingConfiguration::functionResponseTypesAsStrings))
.setter(setter(Builder::functionResponseTypesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FunctionResponseTypes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField AMAZON_MANAGED_KAFKA_EVENT_SOURCE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("AmazonManagedKafkaEventSourceConfig")
.getter(getter(EventSourceMappingConfiguration::amazonManagedKafkaEventSourceConfig))
.setter(setter(Builder::amazonManagedKafkaEventSourceConfig))
.constructor(AmazonManagedKafkaEventSourceConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("AmazonManagedKafkaEventSourceConfig").build()).build();
private static final SdkField SELF_MANAGED_KAFKA_EVENT_SOURCE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("SelfManagedKafkaEventSourceConfig")
.getter(getter(EventSourceMappingConfiguration::selfManagedKafkaEventSourceConfig))
.setter(setter(Builder::selfManagedKafkaEventSourceConfig))
.constructor(SelfManagedKafkaEventSourceConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SelfManagedKafkaEventSourceConfig")
.build()).build();
private static final SdkField SCALING_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ScalingConfig")
.getter(getter(EventSourceMappingConfiguration::scalingConfig)).setter(setter(Builder::scalingConfig))
.constructor(ScalingConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScalingConfig").build()).build();
private static final SdkField DOCUMENT_DB_EVENT_SOURCE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("DocumentDBEventSourceConfig")
.getter(getter(EventSourceMappingConfiguration::documentDBEventSourceConfig))
.setter(setter(Builder::documentDBEventSourceConfig))
.constructor(DocumentDBEventSourceConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DocumentDBEventSourceConfig")
.build()).build();
private static final SdkField KMS_KEY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KMSKeyArn").getter(getter(EventSourceMappingConfiguration::kmsKeyArn))
.setter(setter(Builder::kmsKeyArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KMSKeyArn").build()).build();
private static final SdkField FILTER_CRITERIA_ERROR_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("FilterCriteriaError")
.getter(getter(EventSourceMappingConfiguration::filterCriteriaError)).setter(setter(Builder::filterCriteriaError))
.constructor(FilterCriteriaError::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FilterCriteriaError").build())
.build();
private static final SdkField EVENT_SOURCE_MAPPING_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EventSourceMappingArn").getter(getter(EventSourceMappingConfiguration::eventSourceMappingArn))
.setter(setter(Builder::eventSourceMappingArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventSourceMappingArn").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(UUID_FIELD,
STARTING_POSITION_FIELD, STARTING_POSITION_TIMESTAMP_FIELD, BATCH_SIZE_FIELD,
MAXIMUM_BATCHING_WINDOW_IN_SECONDS_FIELD, PARALLELIZATION_FACTOR_FIELD, EVENT_SOURCE_ARN_FIELD,
FILTER_CRITERIA_FIELD, FUNCTION_ARN_FIELD, LAST_MODIFIED_FIELD, LAST_PROCESSING_RESULT_FIELD, STATE_FIELD,
STATE_TRANSITION_REASON_FIELD, DESTINATION_CONFIG_FIELD, TOPICS_FIELD, QUEUES_FIELD,
SOURCE_ACCESS_CONFIGURATIONS_FIELD, SELF_MANAGED_EVENT_SOURCE_FIELD, MAXIMUM_RECORD_AGE_IN_SECONDS_FIELD,
BISECT_BATCH_ON_FUNCTION_ERROR_FIELD, MAXIMUM_RETRY_ATTEMPTS_FIELD, TUMBLING_WINDOW_IN_SECONDS_FIELD,
FUNCTION_RESPONSE_TYPES_FIELD, AMAZON_MANAGED_KAFKA_EVENT_SOURCE_CONFIG_FIELD,
SELF_MANAGED_KAFKA_EVENT_SOURCE_CONFIG_FIELD, SCALING_CONFIG_FIELD, DOCUMENT_DB_EVENT_SOURCE_CONFIG_FIELD,
KMS_KEY_ARN_FIELD, FILTER_CRITERIA_ERROR_FIELD, EVENT_SOURCE_MAPPING_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String uuid;
private final String startingPosition;
private final Instant startingPositionTimestamp;
private final Integer batchSize;
private final Integer maximumBatchingWindowInSeconds;
private final Integer parallelizationFactor;
private final String eventSourceArn;
private final FilterCriteria filterCriteria;
private final String functionArn;
private final Instant lastModified;
private final String lastProcessingResult;
private final String state;
private final String stateTransitionReason;
private final DestinationConfig destinationConfig;
private final List topics;
private final List queues;
private final List sourceAccessConfigurations;
private final SelfManagedEventSource selfManagedEventSource;
private final Integer maximumRecordAgeInSeconds;
private final Boolean bisectBatchOnFunctionError;
private final Integer maximumRetryAttempts;
private final Integer tumblingWindowInSeconds;
private final List functionResponseTypes;
private final AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig;
private final SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig;
private final ScalingConfig scalingConfig;
private final DocumentDBEventSourceConfig documentDBEventSourceConfig;
private final String kmsKeyArn;
private final FilterCriteriaError filterCriteriaError;
private final String eventSourceMappingArn;
private EventSourceMappingConfiguration(BuilderImpl builder) {
this.uuid = builder.uuid;
this.startingPosition = builder.startingPosition;
this.startingPositionTimestamp = builder.startingPositionTimestamp;
this.batchSize = builder.batchSize;
this.maximumBatchingWindowInSeconds = builder.maximumBatchingWindowInSeconds;
this.parallelizationFactor = builder.parallelizationFactor;
this.eventSourceArn = builder.eventSourceArn;
this.filterCriteria = builder.filterCriteria;
this.functionArn = builder.functionArn;
this.lastModified = builder.lastModified;
this.lastProcessingResult = builder.lastProcessingResult;
this.state = builder.state;
this.stateTransitionReason = builder.stateTransitionReason;
this.destinationConfig = builder.destinationConfig;
this.topics = builder.topics;
this.queues = builder.queues;
this.sourceAccessConfigurations = builder.sourceAccessConfigurations;
this.selfManagedEventSource = builder.selfManagedEventSource;
this.maximumRecordAgeInSeconds = builder.maximumRecordAgeInSeconds;
this.bisectBatchOnFunctionError = builder.bisectBatchOnFunctionError;
this.maximumRetryAttempts = builder.maximumRetryAttempts;
this.tumblingWindowInSeconds = builder.tumblingWindowInSeconds;
this.functionResponseTypes = builder.functionResponseTypes;
this.amazonManagedKafkaEventSourceConfig = builder.amazonManagedKafkaEventSourceConfig;
this.selfManagedKafkaEventSourceConfig = builder.selfManagedKafkaEventSourceConfig;
this.scalingConfig = builder.scalingConfig;
this.documentDBEventSourceConfig = builder.documentDBEventSourceConfig;
this.kmsKeyArn = builder.kmsKeyArn;
this.filterCriteriaError = builder.filterCriteriaError;
this.eventSourceMappingArn = builder.eventSourceMappingArn;
}
/**
*
* The identifier of the event source mapping.
*
*
* @return The identifier of the event source mapping.
*/
public final String uuid() {
return uuid;
}
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
* event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
* MSK, and self-managed Apache Kafka.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #startingPosition}
* will return {@link EventSourcePosition#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #startingPositionAsString}.
*
*
* @return The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
* DocumentDB, Amazon MSK, and self-managed Apache Kafka.
* @see EventSourcePosition
*/
public final EventSourcePosition startingPosition() {
return EventSourcePosition.fromValue(startingPosition);
}
/**
*
* The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream
* event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon
* MSK, and self-managed Apache Kafka.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #startingPosition}
* will return {@link EventSourcePosition#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #startingPositionAsString}.
*
*
* @return The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
* Stream event sources. AT_TIMESTAMP
is supported only for Amazon Kinesis streams, Amazon
* DocumentDB, Amazon MSK, and self-managed Apache Kafka.
* @see EventSourcePosition
*/
public final String startingPositionAsString() {
return startingPosition;
}
/**
*
* With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading.
* StartingPositionTimestamp
cannot be in the future.
*
*
* @return With StartingPosition
set to AT_TIMESTAMP
, the time from which to start
* reading. StartingPositionTimestamp
cannot be in the future.
*/
public final Instant startingPositionTimestamp() {
return startingPositionTimestamp;
}
/**
*
* The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your
* function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit
* for synchronous invocation (6 MB).
*
*
* Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
*
*
* Related setting: When you set BatchSize
to a value greater than 10, you must set
* MaximumBatchingWindowInSeconds
to at least 1.
*
*
* @return The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your
* function. Lambda passes all of the records in the batch to the function in a single call, up to the
* payload limit for synchronous invocation (6 MB).
*
* Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default
* is 100.
*
*
* Related setting: When you set BatchSize
to a value greater than 10, you must set
* MaximumBatchingWindowInSeconds
to at least 1.
*/
public final Integer batchSize() {
return batchSize;
}
/**
*
* The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You
* can configure MaximumBatchingWindowInSeconds
to any value from 0 seconds to 300 seconds in
* increments of seconds.
*
*
* For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed
* Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because
* you can only change MaximumBatchingWindowInSeconds
in increments of seconds, you cannot revert back
* to the 500 ms default batching window after you have changed it. To restore the default batching window, you must
* create a new event source mapping.
*
*
* Related setting: For streams and Amazon SQS event sources, when you set BatchSize
to a value greater
* than 10, you must set MaximumBatchingWindowInSeconds
to at least 1.
*
*
* @return The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the
* function. You can configure MaximumBatchingWindowInSeconds
to any value from 0 seconds to
* 300 seconds in increments of seconds.
*
* For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK,
* Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500
* ms. Note that because you can only change MaximumBatchingWindowInSeconds
in increments of
* seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To
* restore the default batching window, you must create a new event source mapping.
*
*
* Related setting: For streams and Amazon SQS event sources, when you set BatchSize
to a value
* greater than 10, you must set MaximumBatchingWindowInSeconds
to at least 1.
*/
public final Integer maximumBatchingWindowInSeconds() {
return maximumBatchingWindowInSeconds;
}
/**
*
* (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default
* value is 1.
*
*
* @return (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The
* default value is 1.
*/
public final Integer parallelizationFactor() {
return parallelizationFactor;
}
/**
*
* The Amazon Resource Name (ARN) of the event source.
*
*
* @return The Amazon Resource Name (ARN) of the event source.
*/
public final String eventSourceArn() {
return eventSourceArn;
}
/**
*
* An object that defines the filter criteria that determine whether Lambda should process an event. For more
* information, see Lambda
* event filtering.
*
*
* If filter criteria is encrypted, this field shows up as null
in the response of
* ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping
* and DeleteEventSourceMapping calls if you have kms:Decrypt
permissions for the correct KMS key.
*
*
* @return An object that defines the filter criteria that determine whether Lambda should process an event. For
* more information, see Lambda event
* filtering.
*
* If filter criteria is encrypted, this field shows up as null
in the response of
* ListEventSourceMapping API calls. You can view this field in plaintext in the response of
* GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt
permissions
* for the correct KMS key.
*/
public final FilterCriteria filterCriteria() {
return filterCriteria;
}
/**
*
* The ARN of the Lambda function.
*
*
* @return The ARN of the Lambda function.
*/
public final String functionArn() {
return functionArn;
}
/**
*
* The date that the event source mapping was last updated or that its state changed.
*
*
* @return The date that the event source mapping was last updated or that its state changed.
*/
public final Instant lastModified() {
return lastModified;
}
/**
*
* The result of the last Lambda invocation of your function.
*
*
* @return The result of the last Lambda invocation of your function.
*/
public final String lastProcessingResult() {
return lastProcessingResult;
}
/**
*
* The state of the event source mapping. It can be one of the following: Creating
,
* Enabling
, Enabled
, Disabling
, Disabled
, Updating
* , or Deleting
.
*
*
* @return The state of the event source mapping. It can be one of the following: Creating
,
* Enabling
, Enabled
, Disabling
, Disabled
,
* Updating
, or Deleting
.
*/
public final String state() {
return state;
}
/**
*
* Indicates whether a user or Lambda made the last change to the event source mapping.
*
*
* @return Indicates whether a user or Lambda made the last change to the event source mapping.
*/
public final String stateTransitionReason() {
return stateTransitionReason;
}
/**
*
* (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object
* that specifies the destination of an event after Lambda processes it.
*
*
* @return (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration
* object that specifies the destination of an event after Lambda processes it.
*/
public final DestinationConfig destinationConfig() {
return destinationConfig;
}
/**
* For responses, this returns true if the service returned a value for the Topics property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasTopics() {
return topics != null && !(topics instanceof SdkAutoConstructList);
}
/**
*
* The name of the Kafka topic.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTopics} method.
*
*
* @return The name of the Kafka topic.
*/
public final List topics() {
return topics;
}
/**
* For responses, this returns true if the service returned a value for the Queues property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasQueues() {
return queues != null && !(queues instanceof SdkAutoConstructList);
}
/**
*
* (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasQueues} method.
*
*
* @return (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
*/
public final List queues() {
return queues;
}
/**
* For responses, this returns true if the service returned a value for the SourceAccessConfigurations property.
* This DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasSourceAccessConfigurations() {
return sourceAccessConfigurations != null && !(sourceAccessConfigurations instanceof SdkAutoConstructList);
}
/**
*
* An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSourceAccessConfigurations} method.
*
*
* @return An array of the authentication protocol, VPC components, or virtual host to secure and define your event
* source.
*/
public final List sourceAccessConfigurations() {
return sourceAccessConfigurations;
}
/**
*
* The self-managed Apache Kafka cluster for your event source.
*
*
* @return The self-managed Apache Kafka cluster for your event source.
*/
public final SelfManagedEventSource selfManagedEventSource() {
return selfManagedEventSource;
}
/**
*
* (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which
* sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
*
*
*
* The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall
* within the parameter's absolute range, they are not allowed
*
*
*
* @return (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is
* -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old
* records.
*
* The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1
* fall within the parameter's absolute range, they are not allowed
*
*/
public final Integer maximumRecordAgeInSeconds() {
return maximumRecordAgeInSeconds;
}
/**
*
* (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The
* default value is false.
*
*
* @return (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
* The default value is false.
*/
public final Boolean bisectBatchOnFunctionError() {
return bisectBatchOnFunctionError;
}
/**
*
* (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is
* -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries
* failed records until the record expires in the event source.
*
*
* @return (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default
* value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite,
* Lambda retries failed records until the record expires in the event source.
*/
public final Integer maximumRetryAttempts() {
return maximumRetryAttempts;
}
/**
*
* (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis
* Streams event sources. A value of 0 seconds indicates no tumbling window.
*
*
* @return (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and
* Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
*/
public final Integer tumblingWindowInSeconds() {
return tumblingWindowInSeconds;
}
/**
*
* (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source
* mapping.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFunctionResponseTypes} method.
*
*
* @return (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
* source mapping.
*/
public final List functionResponseTypes() {
return FunctionResponseTypeListCopier.copyStringToEnum(functionResponseTypes);
}
/**
* For responses, this returns true if the service returned a value for the FunctionResponseTypes property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasFunctionResponseTypes() {
return functionResponseTypes != null && !(functionResponseTypes instanceof SdkAutoConstructList);
}
/**
*
* (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source
* mapping.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFunctionResponseTypes} method.
*
*
* @return (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event
* source mapping.
*/
public final List functionResponseTypesAsStrings() {
return functionResponseTypes;
}
/**
*
* Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
*
*
* @return Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event
* source.
*/
public final AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig() {
return amazonManagedKafkaEventSourceConfig;
}
/**
*
* Specific configuration settings for a self-managed Apache Kafka event source.
*
*
* @return Specific configuration settings for a self-managed Apache Kafka event source.
*/
public final SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig() {
return selfManagedKafkaEventSourceConfig;
}
/**
*
* (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum
* concurrency for Amazon SQS event sources.
*
*
* @return (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring
* maximum concurrency for Amazon SQS event sources.
*/
public final ScalingConfig scalingConfig() {
return scalingConfig;
}
/**
*
* Specific configuration settings for a DocumentDB event source.
*
*
* @return Specific configuration settings for a DocumentDB event source.
*/
public final DocumentDBEventSourceConfig documentDBEventSourceConfig() {
return documentDBEventSourceConfig;
}
/**
*
* The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter
* criteria.
*
*
* @return The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your
* function's filter criteria.
*/
public final String kmsKeyArn() {
return kmsKeyArn;
}
/**
*
* An object that contains details about an error related to filter criteria encryption.
*
*
* @return An object that contains details about an error related to filter criteria encryption.
*/
public final FilterCriteriaError filterCriteriaError() {
return filterCriteriaError;
}
/**
*
* The Amazon Resource Name (ARN) of the event source mapping.
*
*
* @return The Amazon Resource Name (ARN) of the event source mapping.
*/
public final String eventSourceMappingArn() {
return eventSourceMappingArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(uuid());
hashCode = 31 * hashCode + Objects.hashCode(startingPositionAsString());
hashCode = 31 * hashCode + Objects.hashCode(startingPositionTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(batchSize());
hashCode = 31 * hashCode + Objects.hashCode(maximumBatchingWindowInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(parallelizationFactor());
hashCode = 31 * hashCode + Objects.hashCode(eventSourceArn());
hashCode = 31 * hashCode + Objects.hashCode(filterCriteria());
hashCode = 31 * hashCode + Objects.hashCode(functionArn());
hashCode = 31 * hashCode + Objects.hashCode(lastModified());
hashCode = 31 * hashCode + Objects.hashCode(lastProcessingResult());
hashCode = 31 * hashCode + Objects.hashCode(state());
hashCode = 31 * hashCode + Objects.hashCode(stateTransitionReason());
hashCode = 31 * hashCode + Objects.hashCode(destinationConfig());
hashCode = 31 * hashCode + Objects.hashCode(hasTopics() ? topics() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasQueues() ? queues() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSourceAccessConfigurations() ? sourceAccessConfigurations() : null);
hashCode = 31 * hashCode + Objects.hashCode(selfManagedEventSource());
hashCode = 31 * hashCode + Objects.hashCode(maximumRecordAgeInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(bisectBatchOnFunctionError());
hashCode = 31 * hashCode + Objects.hashCode(maximumRetryAttempts());
hashCode = 31 * hashCode + Objects.hashCode(tumblingWindowInSeconds());
hashCode = 31 * hashCode + Objects.hashCode(hasFunctionResponseTypes() ? functionResponseTypesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(amazonManagedKafkaEventSourceConfig());
hashCode = 31 * hashCode + Objects.hashCode(selfManagedKafkaEventSourceConfig());
hashCode = 31 * hashCode + Objects.hashCode(scalingConfig());
hashCode = 31 * hashCode + Objects.hashCode(documentDBEventSourceConfig());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyArn());
hashCode = 31 * hashCode + Objects.hashCode(filterCriteriaError());
hashCode = 31 * hashCode + Objects.hashCode(eventSourceMappingArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EventSourceMappingConfiguration)) {
return false;
}
EventSourceMappingConfiguration other = (EventSourceMappingConfiguration) obj;
return Objects.equals(uuid(), other.uuid())
&& Objects.equals(startingPositionAsString(), other.startingPositionAsString())
&& Objects.equals(startingPositionTimestamp(), other.startingPositionTimestamp())
&& Objects.equals(batchSize(), other.batchSize())
&& Objects.equals(maximumBatchingWindowInSeconds(), other.maximumBatchingWindowInSeconds())
&& Objects.equals(parallelizationFactor(), other.parallelizationFactor())
&& Objects.equals(eventSourceArn(), other.eventSourceArn())
&& Objects.equals(filterCriteria(), other.filterCriteria()) && Objects.equals(functionArn(), other.functionArn())
&& Objects.equals(lastModified(), other.lastModified())
&& Objects.equals(lastProcessingResult(), other.lastProcessingResult()) && Objects.equals(state(), other.state())
&& Objects.equals(stateTransitionReason(), other.stateTransitionReason())
&& Objects.equals(destinationConfig(), other.destinationConfig()) && hasTopics() == other.hasTopics()
&& Objects.equals(topics(), other.topics()) && hasQueues() == other.hasQueues()
&& Objects.equals(queues(), other.queues())
&& hasSourceAccessConfigurations() == other.hasSourceAccessConfigurations()
&& Objects.equals(sourceAccessConfigurations(), other.sourceAccessConfigurations())
&& Objects.equals(selfManagedEventSource(), other.selfManagedEventSource())
&& Objects.equals(maximumRecordAgeInSeconds(), other.maximumRecordAgeInSeconds())
&& Objects.equals(bisectBatchOnFunctionError(), other.bisectBatchOnFunctionError())
&& Objects.equals(maximumRetryAttempts(), other.maximumRetryAttempts())
&& Objects.equals(tumblingWindowInSeconds(), other.tumblingWindowInSeconds())
&& hasFunctionResponseTypes() == other.hasFunctionResponseTypes()
&& Objects.equals(functionResponseTypesAsStrings(), other.functionResponseTypesAsStrings())
&& Objects.equals(amazonManagedKafkaEventSourceConfig(), other.amazonManagedKafkaEventSourceConfig())
&& Objects.equals(selfManagedKafkaEventSourceConfig(), other.selfManagedKafkaEventSourceConfig())
&& Objects.equals(scalingConfig(), other.scalingConfig())
&& Objects.equals(documentDBEventSourceConfig(), other.documentDBEventSourceConfig())
&& Objects.equals(kmsKeyArn(), other.kmsKeyArn())
&& Objects.equals(filterCriteriaError(), other.filterCriteriaError())
&& Objects.equals(eventSourceMappingArn(), other.eventSourceMappingArn());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("EventSourceMappingConfiguration").add("UUID", uuid())
.add("StartingPosition", startingPositionAsString())
.add("StartingPositionTimestamp", startingPositionTimestamp()).add("BatchSize", batchSize())
.add("MaximumBatchingWindowInSeconds", maximumBatchingWindowInSeconds())
.add("ParallelizationFactor", parallelizationFactor()).add("EventSourceArn", eventSourceArn())
.add("FilterCriteria", filterCriteria()).add("FunctionArn", functionArn()).add("LastModified", lastModified())
.add("LastProcessingResult", lastProcessingResult()).add("State", state())
.add("StateTransitionReason", stateTransitionReason()).add("DestinationConfig", destinationConfig())
.add("Topics", hasTopics() ? topics() : null).add("Queues", hasQueues() ? queues() : null)
.add("SourceAccessConfigurations", hasSourceAccessConfigurations() ? sourceAccessConfigurations() : null)
.add("SelfManagedEventSource", selfManagedEventSource())
.add("MaximumRecordAgeInSeconds", maximumRecordAgeInSeconds())
.add("BisectBatchOnFunctionError", bisectBatchOnFunctionError())
.add("MaximumRetryAttempts", maximumRetryAttempts()).add("TumblingWindowInSeconds", tumblingWindowInSeconds())
.add("FunctionResponseTypes", hasFunctionResponseTypes() ? functionResponseTypesAsStrings() : null)
.add("AmazonManagedKafkaEventSourceConfig", amazonManagedKafkaEventSourceConfig())
.add("SelfManagedKafkaEventSourceConfig", selfManagedKafkaEventSourceConfig())
.add("ScalingConfig", scalingConfig()).add("DocumentDBEventSourceConfig", documentDBEventSourceConfig())
.add("KMSKeyArn", kmsKeyArn()).add("FilterCriteriaError", filterCriteriaError())
.add("EventSourceMappingArn", eventSourceMappingArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UUID":
return Optional.ofNullable(clazz.cast(uuid()));
case "StartingPosition":
return Optional.ofNullable(clazz.cast(startingPositionAsString()));
case "StartingPositionTimestamp":
return Optional.ofNullable(clazz.cast(startingPositionTimestamp()));
case "BatchSize":
return Optional.ofNullable(clazz.cast(batchSize()));
case "MaximumBatchingWindowInSeconds":
return Optional.ofNullable(clazz.cast(maximumBatchingWindowInSeconds()));
case "ParallelizationFactor":
return Optional.ofNullable(clazz.cast(parallelizationFactor()));
case "EventSourceArn":
return Optional.ofNullable(clazz.cast(eventSourceArn()));
case "FilterCriteria":
return Optional.ofNullable(clazz.cast(filterCriteria()));
case "FunctionArn":
return Optional.ofNullable(clazz.cast(functionArn()));
case "LastModified":
return Optional.ofNullable(clazz.cast(lastModified()));
case "LastProcessingResult":
return Optional.ofNullable(clazz.cast(lastProcessingResult()));
case "State":
return Optional.ofNullable(clazz.cast(state()));
case "StateTransitionReason":
return Optional.ofNullable(clazz.cast(stateTransitionReason()));
case "DestinationConfig":
return Optional.ofNullable(clazz.cast(destinationConfig()));
case "Topics":
return Optional.ofNullable(clazz.cast(topics()));
case "Queues":
return Optional.ofNullable(clazz.cast(queues()));
case "SourceAccessConfigurations":
return Optional.ofNullable(clazz.cast(sourceAccessConfigurations()));
case "SelfManagedEventSource":
return Optional.ofNullable(clazz.cast(selfManagedEventSource()));
case "MaximumRecordAgeInSeconds":
return Optional.ofNullable(clazz.cast(maximumRecordAgeInSeconds()));
case "BisectBatchOnFunctionError":
return Optional.ofNullable(clazz.cast(bisectBatchOnFunctionError()));
case "MaximumRetryAttempts":
return Optional.ofNullable(clazz.cast(maximumRetryAttempts()));
case "TumblingWindowInSeconds":
return Optional.ofNullable(clazz.cast(tumblingWindowInSeconds()));
case "FunctionResponseTypes":
return Optional.ofNullable(clazz.cast(functionResponseTypesAsStrings()));
case "AmazonManagedKafkaEventSourceConfig":
return Optional.ofNullable(clazz.cast(amazonManagedKafkaEventSourceConfig()));
case "SelfManagedKafkaEventSourceConfig":
return Optional.ofNullable(clazz.cast(selfManagedKafkaEventSourceConfig()));
case "ScalingConfig":
return Optional.ofNullable(clazz.cast(scalingConfig()));
case "DocumentDBEventSourceConfig":
return Optional.ofNullable(clazz.cast(documentDBEventSourceConfig()));
case "KMSKeyArn":
return Optional.ofNullable(clazz.cast(kmsKeyArn()));
case "FilterCriteriaError":
return Optional.ofNullable(clazz.cast(filterCriteriaError()));
case "EventSourceMappingArn":
return Optional.ofNullable(clazz.cast(eventSourceMappingArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function