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

Class DeleteEventSourceMappingResponse

    • Method Detail

      • uuid

        public final String uuid()

        The identifier of the event source mapping.

        Returns:
        The identifier of the event source mapping.

      • 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:
        EventSourcePosition

      • 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:
        EventSourcePosition

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

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

        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.

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

        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.

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

      • parallelizationFactor

        public final Integer parallelizationFactor()

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

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

      • eventSourceArn

        public final String eventSourceArn()

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

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

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

        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.

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

      • functionArn

        public final String functionArn()

        The ARN of the Lambda function.

        Returns:
        The ARN of the Lambda function.

      • lastModified

        public final Instant lastModified()

        The date that the event source mapping was last updated or that its state changed.

        Returns:
        The date that the event source mapping was last updated or that its state changed.

      • lastProcessingResult

        public final String lastProcessingResult()

        The result of the last Lambda invocation of your function.

        Returns:
        The result of the last Lambda invocation of your function.

      • state

        public final String state()

        The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating , or Deleting.

        Returns:
        The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

      • stateTransitionReason

        public final String stateTransitionReason()

        Indicates whether a user or Lambda made the last change to the event source mapping.

        Returns:
        Indicates whether a user or Lambda made the last change to the event source mapping.

      • destinationConfig

        public final DestinationConfig destinationConfig()

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

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

      • 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()

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

        Returns:
        (Amazon 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 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 hasSourceAccessConfigurations() method.

        Returns:
        An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

      • selfManagedEventSource

        public final SelfManagedEventSource selfManagedEventSource()

        The self-managed Apache Kafka cluster for your event source.

        Returns:
        The self-managed Apache Kafka cluster for your event source.

      • maximumRecordAgeInSeconds

        public final Integer maximumRecordAgeInSeconds()

        (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

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

      • bisectBatchOnFunctionError

        public final Boolean bisectBatchOnFunctionError()

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

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

      • maximumRetryAttempts

        public final Integer maximumRetryAttempts()

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

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

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

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

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

        Returns:
        The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

      • filterCriteriaError

        public final FilterCriteriaError filterCriteriaError()

        An object that contains details about an error related to filter criteria encryption.

        Returns:
        An object that contains details about an error related to filter criteria encryption.

      • eventSourceMappingArn

        public final String eventSourceMappingArn()

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

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

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

      • 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