Class: MintPress::Aws::Lambda::EventSourceMapping

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb

Properties (Read/Write)

  • #event_source_arn ⇒ [String]
    '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.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'event_source_arn'
    • read_only ⇒ false
    • source ⇒ "list_event_source_mappings"
    • list_event_source_mappings_prop ⇒ 'event_source_arn'
    

27
28
29
30
31
32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 27

property :event_source_arn, create_event_source_mapping_prop: 'event_source_arn', type: [String], read_only: false, source: "list_event_source_mappings", description: '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.', list_event_source_mappings_prop: 'event_source_arn'
  • #function_name ⇒ [String] (Default Value: Proc.new { self.name })
    '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.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'function_name'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • list_event_source_mappings_prop ⇒ 'function_name'
    • update_event_source_mapping_prop ⇒ 'function_name'
    • default ⇒ Proc.new { self.name }
    

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 36

property :function_name, create_event_source_mapping_prop: 'function_name', type: [String], read_only: false, source: "update_event_source_mapping", description: '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.', list_event_source_mappings_prop: 'function_name', update_event_source_mapping_prop: 'function_name', default: Proc.new { self.name }
  • #enabled ⇒ [TrueClass,FalseClass]
    'If true, the event source mapping is active. Set to false to pause polling and invocation.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'enabled'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'enabled'
    

52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 52

property :enabled, create_event_source_mapping_prop: 'enabled', type: [TrueClass,FalseClass], read_only: false, source: "update_event_source_mapping", description: 'If true, the event source mapping is active. Set to false to pause
polling and invocation.', update_event_source_mapping_prop: 'enabled'
  • #batch_size ⇒ [Integer]
    'The maximum number of items to retrieve in a single batch. Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 1,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.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'batch_size'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'batch_size'
    

54
55
56
57
58
59
60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 54

property :batch_size, create_event_source_mapping_prop: 'batch_size', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'The maximum number of items to retrieve in a single batch.


Amazon Kinesis - Default 100. Max 10,000.
Amazon DynamoDB Streams - Default 100. Max 1,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.', update_event_source_mapping_prop: 'batch_size'
  • #maximum_batching_window_in_seconds ⇒ [Integer]
    'The maximum amount of time to gather records before invoking the function, in seconds.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'maximum_batching_window_in_seconds'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'maximum_batching_window_in_seconds'
    

64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 64

property :maximum_batching_window_in_seconds, create_event_source_mapping_prop: 'maximum_batching_window_in_seconds', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'The maximum amount of time to gather
records before invoking the function, in seconds.', update_event_source_mapping_prop: 'maximum_batching_window_in_seconds'
  • #parallelization_factor ⇒ [Integer]
    'The number of batches to process from each shard concurrently.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'parallelization_factor'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'parallelization_factor'
    

66
67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 66

property :parallelization_factor, create_event_source_mapping_prop: 'parallelization_factor', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'The number of batches to process from each shard
concurrently.', update_event_source_mapping_prop: 'parallelization_factor'
  • #starting_position ⇒ [String]
    'The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'starting_position'
    • read_only ⇒ false
    • source ⇒ "create_event_source_mapping"
    

68
69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 68

property :starting_position, create_event_source_mapping_prop: 'starting_position', type: [String], read_only: false, source: "create_event_source_mapping", description: 'The position in a stream from which to start reading. Required for
Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.
AT_TIMESTAMP is only supported for Amazon Kinesis streams.'
  • #starting_position_timestamp ⇒ [Time,DateTime,Integer]
    'With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'starting_position_timestamp'
    • read_only ⇒ false
    • source ⇒ "create_event_source_mapping"
    

71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 71

property :starting_position_timestamp, create_event_source_mapping_prop: 'starting_position_timestamp', type: [Time,DateTime,Integer], read_only: false, source: "create_event_source_mapping", description: 'With StartingPosition set to AT_TIMESTAMP, the time from which to
start reading.'
  • #destination_config ⇒ [MintPress::Aws::Lambda::DestinationConfig] (Default Value: MintPress::Aws::Lambda::DestinationConfig.new)
    'An Amazon SQS queue or Amazon SNS topic destination for discarded records.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'destination_config'
    • default ⇒ MintPress::Aws::Lambda::DestinationConfig.new
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'destination_config'
    

73
74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 73

property :destination_config, create_event_source_mapping_prop: 'destination_config', type: [MintPress::Aws::Lambda::DestinationConfig], default: MintPress::Aws::Lambda::DestinationConfig.new, read_only: false, source: "update_event_source_mapping", description: 'An Amazon SQS queue or Amazon SNS topic destination for
discarded records.', update_event_source_mapping_prop: 'destination_config'
  • #maximum_record_age_in_seconds ⇒ [Integer]
    'Discard records older than the specified age. The default value is infinite (-1).'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'maximum_record_age_in_seconds'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'maximum_record_age_in_seconds'
    

75
76
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 75

property :maximum_record_age_in_seconds, create_event_source_mapping_prop: 'maximum_record_age_in_seconds', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'Discard records older than the specified age. The default
value is infinite (-1).', update_event_source_mapping_prop: 'maximum_record_age_in_seconds'
  • #bisect_batch_on_function_error ⇒ [TrueClass,FalseClass]
    'If the function returns an error, split the batch in two and retry.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'bisect_batch_on_function_error'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'bisect_batch_on_function_error'
    

77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 77

property :bisect_batch_on_function_error, create_event_source_mapping_prop: 'bisect_batch_on_function_error', type: [TrueClass,FalseClass], read_only: false, source: "update_event_source_mapping", description: 'If the function returns an error, split the batch in two and
retry.', update_event_source_mapping_prop: 'bisect_batch_on_function_error'
  • #maximum_retry_attempts ⇒ [Integer]
    'Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'maximum_retry_attempts'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'maximum_retry_attempts'
    

79
80
81
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 79

property :maximum_retry_attempts, create_event_source_mapping_prop: 'maximum_retry_attempts', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'Discard records after the specified number of retries. The
default value is infinite (-1). When set to infinite (-1), failed
records will be retried until the record expires.', update_event_source_mapping_prop: 'maximum_retry_attempts'
  • #tumbling_window_in_seconds ⇒ [Integer]
    'The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'tumbling_window_in_seconds'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'tumbling_window_in_seconds'
    

82
83
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 82

property :tumbling_window_in_seconds, create_event_source_mapping_prop: 'tumbling_window_in_seconds', type: [Integer], read_only: false, source: "update_event_source_mapping", description: 'The duration of a processing window in seconds. The range is
between 1 second up to 15 minutes.', update_event_source_mapping_prop: 'tumbling_window_in_seconds'
  • #topics ⇒ Array of ⇒ [String]
    'The name of the Kafka topic.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'topics'
    • read_only ⇒ false
    • source ⇒ "create_event_source_mapping"
    

84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 84

property :topics, create_event_source_mapping_prop: 'topics', type: [String], array: true, read_only: false, source: "create_event_source_mapping", description: 'The name of the Kafka topic.'
  • #queues ⇒ Array of ⇒ [String]
    'The name of the Amazon MQ broker destination queue to consume.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'queues'
    • read_only ⇒ false
    • source ⇒ "create_event_source_mapping"
    

85
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 85

property :queues, create_event_source_mapping_prop: 'queues', type: [String], array: true, read_only: false, source: "create_event_source_mapping", description: 'The name of the Amazon MQ broker destination queue to consume.'
  • #source_access_configurations ⇒ Array of ⇒ [MintPress::Aws::Lambda::SourceAccessConfiguration]
    'An array of the authentication protocol, or the VPC components to secure your event source.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'source_access_configurations'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'source_access_configurations'
    

86
87
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 86

property :source_access_configurations, create_event_source_mapping_prop: 'source_access_configurations', type: [MintPress::Aws::Lambda::SourceAccessConfiguration], array: true, read_only: false, source: "update_event_source_mapping", description: 'An array of the authentication protocol, or the VPC components to
secure your event source.', update_event_source_mapping_prop: 'source_access_configurations'
  • #self_managed_event_source ⇒ []
    'The Self-Managed Apache Kafka cluster to send records.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ "self_managed_event_source.endpoints"
    • read_only ⇒ false
    • source ⇒ "create_event_source_mapping"
    

88
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 88

property :self_managed_event_source, create_event_source_mapping_prop: "self_managed_event_source.endpoints", type: [], read_only: false, source: "create_event_source_mapping", description: 'The Self-Managed Apache Kafka cluster to send records.'
  • #function_response_types ⇒ Array of ⇒ [String]
    'A list of current response type enums applied to the event source mapping.'
    Property Attributes
    • create_event_source_mapping_prop ⇒ 'function_response_types'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • update_event_source_mapping_prop ⇒ 'function_response_types'
    

89
90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 89

property :function_response_types, create_event_source_mapping_prop: 'function_response_types', type: [String], array: true, read_only: false, source: "update_event_source_mapping", description: 'A list of current response type enums applied to the event
source mapping.', update_event_source_mapping_prop: 'function_response_types'
  • #uuid ⇒ [String]
    'The identifier of the event source mapping.'
    Property Attributes
    • delete_event_source_mapping_prop ⇒ 'uuid'
    • read_only ⇒ false
    • source ⇒ "update_event_source_mapping"
    • get_event_source_mapping_prop ⇒ 'uuid'
    • update_event_source_mapping_prop ⇒ 'uuid'
    

91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 91

property :uuid, delete_event_source_mapping_prop: 'uuid', type: [String], read_only: false, source: "update_event_source_mapping", description: 'The identifier of the event source mapping.', get_event_source_mapping_prop: 'uuid', update_event_source_mapping_prop: 'uuid'
  • #max_items ⇒ [Integer]
    'The maximum number of event source mappings to return.'
    Property Attributes
    • list_event_source_mappings_prop ⇒ 'max_items'
    • read_only ⇒ false
    • source ⇒ "list_event_source_mappings"
    

92
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 92

property :max_items, list_event_source_mappings_prop: 'max_items', type: [Integer], read_only: false, source: "list_event_source_mappings", description: 'The maximum number of event source mappings to return.'
  • #name ⇒ [String]

    Property Attributes 
    

93
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 93

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

97
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 97

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

100
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/event_source_mapping.rb', line 100

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ EventSourceMapping

Returns a new instance of EventSourceMapping.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#list ⇒ Object

#update ⇒ Object