Class CreateEventSourceMappingRequest

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.CreateEventSourceMappingRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEventSourceMappingRequest extends LambdaRequest implements ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>

  • Method Details

    • eventSourceArn

      public final String eventSourceArn()

      The Amazon Resource Name (ARN) of the event source.

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.

      • Amazon DynamoDB Streams – The ARN of the stream.

      • Amazon Simple Queue Service – The ARN of the queue.

      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

      • Amazon MQ – The ARN of the broker.

      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

      Returns:
      The Amazon Resource Name (ARN) of the event source.

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.

      • Amazon DynamoDB Streams – The ARN of the stream.

      • Amazon Simple Queue Service – The ARN of the queue.

      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

      • Amazon MQ – The ARN of the broker.

      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

    • functionName

      public final String functionName()

      The name or ARN 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 or ARN 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

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

    • startingPosition

      public final EventSourcePosition 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, startingPosition will return EventSourcePosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

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

    • startingPositionAsString

      public final String startingPositionAsString()

      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, startingPosition will return EventSourcePosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

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

    • startingPositionTimestamp

      public final Instant startingPositionTimestamp()

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

      Returns:
      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    • destinationConfig

      public final DestinationConfig destinationConfig()

      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

      Returns:
      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      A list of tags to apply 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 hasTags() method.

      Returns:
      A list of tags to apply to the event source mapping.

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

    • hasTopics

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

    • topics

      public final List<String> topics()

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

      Returns:
      The name of the Kafka topic.

    • hasQueues

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

    • queues

      public final List<String> queues()

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

      Returns:
      (MQ) The name of the Amazon MQ broker destination queue to consume.

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

    • selfManagedEventSource

      public final SelfManagedEventSource selfManagedEventSource()

      The self-managed Apache Kafka cluster to receive records from.

      Returns:
      The self-managed Apache Kafka cluster to receive records from.

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

    • amazonManagedKafkaEventSourceConfig

      public final AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig()

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      Returns:
      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    • selfManagedKafkaEventSourceConfig

      public final SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig()

      Specific configuration settings for a self-managed Apache Kafka event source.

      Returns:
      Specific configuration settings for a self-managed Apache Kafka event source.

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

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

      Returns:
      The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

    • metricsConfig

      public final EventSourceMappingMetricsConfig metricsConfig()

      The metrics configuration for your event source. For more information, see Event source mapping metrics.

      Returns:
      The metrics configuration for your event source. For more information, see Event source mapping metrics.

    • provisionedPollerConfig

      public final ProvisionedPollerConfig provisionedPollerConfig()

      (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

      Returns:
      (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

    • toBuilder

      public CreateEventSourceMappingRequest.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<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
      Specified by:
      toBuilder in class LambdaRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEventSourceMappingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEventSourceMappingRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.