Package software.amazon.awssdk.services.lambda.model

Class UpdateEventSourceMappingRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lambda.model.LambdaRequest
software.amazon.awssdk.services.lambda.model.UpdateEventSourceMappingRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateEventSourceMappingRequest extends LambdaRequest implements ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>

  • Method Details

    • uuid

      public final String uuid()

      The identifier of the event source mapping.

      Returns:
      The identifier of the event source mapping.

    • functionName

      public final String functionName()

      The name of the Lambda function.

      Name formats

      • Function name – MyFunction.

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN – 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

      Returns:
      The name of the Lambda function.

      Name formats

      • Function name – MyFunction.

      • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .

      • Partial ARN – 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

    • enabled

      public final Boolean enabled()

      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

      Returns:
      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

    • batchSize

      public final Integer batchSize()

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

      • Amazon Kinesis – Default 100. Max 10,000.

      • Amazon DynamoDB Streams – Default 100. Max 10,000.

      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

      • Self-managed Apache Kafka – Default 100. Max 10,000.

      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

      • DocumentDB – Default 100. Max 10,000.

      Returns:
      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).

      • Amazon Kinesis – Default 100. Max 10,000.

      • Amazon DynamoDB Streams – Default 100. Max 10,000.

      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

      • Self-managed Apache Kafka – Default 100. Max 10,000.

      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

      • DocumentDB – Default 100. Max 10,000.

    • filterCriteria

      public final FilterCriteria filterCriteria()

      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

      Returns:
      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

    • maximumBatchingWindowInSeconds

      public final Integer maximumBatchingWindowInSeconds()

      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.

      Returns:
      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.

    • destinationConfig

      public final DestinationConfig destinationConfig()

      (Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.

      Returns:
      (Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.

    • maximumRecordAgeInSeconds

      public final Integer maximumRecordAgeInSeconds()

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

      Returns:
      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

    • bisectBatchOnFunctionError

      public final Boolean bisectBatchOnFunctionError()

      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

      Returns:
      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

    • maximumRetryAttempts

      public final Integer maximumRetryAttempts()

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

      Returns:
      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    • parallelizationFactor

      public final Integer parallelizationFactor()

      (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

      Returns:
      (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.

    • hasSourceAccessConfigurations

      public final boolean hasSourceAccessConfigurations()
      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 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.

    • sourceAccessConfigurations

      public final List<SourceAccessConfiguration> sourceAccessConfigurations()

      An array of authentication protocols or VPC components required to secure 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 hasSourceAccessConfigurations() method.

      Returns:
      An array of authentication protocols or VPC components required to secure your event source.

    • tumblingWindowInSeconds

      public final Integer tumblingWindowInSeconds()

      (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.

      Returns:
      (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.

    • functionResponseTypes

      public final List<FunctionResponseType> functionResponseTypes()

      (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 hasFunctionResponseTypes() method.

      Returns:
      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    • hasFunctionResponseTypes

      public final boolean hasFunctionResponseTypes()
      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 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.

    • functionResponseTypesAsStrings

      public final List<String> functionResponseTypesAsStrings()

      (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 hasFunctionResponseTypes() method.

      Returns:
      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

    • scalingConfig

      public final ScalingConfig scalingConfig()

      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

      Returns:
      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

    • documentDBEventSourceConfig

      public final DocumentDBEventSourceConfig documentDBEventSourceConfig()

      Specific configuration settings for a DocumentDB event source.

      Returns:
      Specific configuration settings for a DocumentDB event source.

    • toBuilder

      public UpdateEventSourceMappingRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateEventSourceMappingRequest.Builder,UpdateEventSourceMappingRequest>
      Specified by:
      toBuilder in class LambdaRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateEventSourceMappingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateEventSourceMappingRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.