CreateEventSourceMappingRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class CreateEventSourceMappingRequest
extends LambdaRequest
implements ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEventSourceMappingRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEventSourceMappingRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmazonManagedKafkaEventSourceConfig`	`amazonManagedKafkaEventSourceConfig()` Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
`Integer`	`batchSize()` The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
`Boolean`	`bisectBatchOnFunctionError()` (Streams only) If the function returns an error, split the batch in two and retry.
`static CreateEventSourceMappingRequest.Builder`	`builder()`
`DestinationConfig`	`destinationConfig()` (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
`Boolean`	`enabled()` When true, the event source mapping is active.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventSourceArn()` The Amazon Resource Name (ARN) of the event source.
`FilterCriteria`	`filterCriteria()` (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event.
`String`	`functionName()` The name of the Lambda function.
`List<FunctionResponseType>`	`functionResponseTypes()` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`List<String>`	`functionResponseTypesAsStrings()` (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFunctionResponseTypes()` For responses, this returns true if the service returned a value for the FunctionResponseTypes property.
`int`	`hashCode()`
`boolean`	`hasQueues()` For responses, this returns true if the service returned a value for the Queues property.
`boolean`	`hasSourceAccessConfigurations()` For responses, this returns true if the service returned a value for the SourceAccessConfigurations property.
`boolean`	`hasTopics()` For responses, this returns true if the service returned a value for the Topics property.
`Integer`	`maximumBatchingWindowInSeconds()` (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
`Integer`	`maximumRecordAgeInSeconds()` (Streams only) Discard records older than the specified age.
`Integer`	`maximumRetryAttempts()` (Streams only) Discard records after the specified number of retries.
`Integer`	`parallelizationFactor()` (Streams only) The number of batches to process from each shard concurrently.
`List<String>`	`queues()` (MQ) The name of the Amazon MQ broker destination queue to consume.
`List<SdkField<?>>`	`sdkFields()`
`SelfManagedEventSource`	`selfManagedEventSource()` The self-managed Apache Kafka cluster to receive records from.
`SelfManagedKafkaEventSourceConfig`	`selfManagedKafkaEventSourceConfig()` Specific configuration settings for a self-managed Apache Kafka event source.
`static Class<? extends CreateEventSourceMappingRequest.Builder>`	`serializableBuilderClass()`
`List<SourceAccessConfiguration>`	`sourceAccessConfigurations()` An array of authentication protocols or VPC components required to secure your event source.
`EventSourcePosition`	`startingPosition()` The position in a stream from which to start reading.
`String`	`startingPositionAsString()` The position in a stream from which to start reading.
`Instant`	`startingPositionTimestamp()` With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading.
`CreateEventSourceMappingRequest.Builder`	`toBuilder()`
`List<String>`	`topics()` The name of the Kafka topic.
`String`	`toString()` Returns a string representation of this object.
`Integer`	`tumblingWindowInSeconds()` (Streams only) The duration in seconds of a processing window.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
    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.
  - 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.
    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.
  - filterCriteria
```
public final FilterCriteria filterCriteria()
```
    (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    
    Returns:
    
    (Streams and Amazon SQS) 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()
```
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
    
    Returns:
    
    (Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
    
    Default: 0
    
    Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
  - parallelizationFactor
```
public final Integer parallelizationFactor()
```
    (Streams only) The number of batches to process from each shard concurrently.
    
    Returns:
    
    (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, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    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, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - startingPositionAsString
```
public final String startingPositionAsString()
```
    The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    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, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
    
    See Also:
    
    EventSourcePosition
  - startingPositionTimestamp
```
public final Instant startingPositionTimestamp()
```
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
    
    Returns:
    
    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
  - destinationConfig
```
public final DestinationConfig destinationConfig()
```
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
    
    Returns:
    
    (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
  - maximumRecordAgeInSeconds
```
public final Integer maximumRecordAgeInSeconds()
```
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
    
    Returns:
    
    (Streams only) Discard records older than the specified age. The default value is infinite (-1).
  - bisectBatchOnFunctionError
```
public final Boolean bisectBatchOnFunctionError()
```
    (Streams only) If the function returns an error, split the batch in two and retry.
    
    Returns:
    
    (Streams only) If the function returns an error, split the batch in two and retry.
  - maximumRetryAttempts
```
public final Integer maximumRetryAttempts()
```
    (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:
    
    (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.
  - tumblingWindowInSeconds
```
public final Integer tumblingWindowInSeconds()
```
    (Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.
    
    Returns:
    
    (Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.
  - 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()
```
    (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:
    
    (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()
```
    (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:
    
    (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.
  - toBuilder
```
public CreateEventSourceMappingRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
    
    Specified by:
    
    toBuilder in class LambdaRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateEventSourceMappingRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

eventSourceArn

functionName

enabled

batchSize

filterCriteria

maximumBatchingWindowInSeconds

parallelizationFactor

startingPosition

startingPositionAsString

startingPositionTimestamp

destinationConfig

maximumRecordAgeInSeconds

bisectBatchOnFunctionError

maximumRetryAttempts

tumblingWindowInSeconds

hasTopics

topics

hasQueues

queues

hasSourceAccessConfigurations

sourceAccessConfigurations

selfManagedEventSource

functionResponseTypes

hasFunctionResponseTypes

functionResponseTypesAsStrings

amazonManagedKafkaEventSourceConfig

selfManagedKafkaEventSourceConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields