Class: AWSCDK::Lambda::CfnEventSourceMapping

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLambda::IEventSourceMappingRef
Defined in:
lambda/cfn_event_source_mapping.rb

Overview

The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnEventSourceMapping

Create a new AWS::Lambda::EventSourceMapping.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Lambda::CfnEventSourceMappingProps) —

    Resource properties.



30
31
32
33
34
35
36
 
# File 'lambda/cfn_event_source_mapping.rb', line 30

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMappingProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbkV2ZW50U291cmNlTWFwcGluZ1Byb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_event_source_mapping(resource) ⇒ String

Parameters:

Returns:

  • (String) 


112
113
114
115
 
# File 'lambda/cfn_event_source_mapping.rb', line 112

def self.arn_for_event_source_mapping(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sYW1iZGEuSUV2ZW50U291cmNlTWFwcGluZ1JlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnEventSourceMapping", "arnForEventSourceMapping", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


219
220
221
 
# File 'lambda/cfn_event_source_mapping.rb', line 219

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lambda.CfnEventSourceMapping", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_event_source_mapping(x) ⇒ Boolean

Checks whether the given object is a CfnEventSourceMapping.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


121
122
123
124
 
# File 'lambda/cfn_event_source_mapping.rb', line 121

def self.is_cfn_event_source_mapping(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lambda.CfnEventSourceMapping", "isCfnEventSourceMapping", [x])
end

.jsii_overridable_methods ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lambda/cfn_event_source_mapping.rb', line 38

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_event_source_mapping_arn => { kind: :property, name: "attrEventSourceMappingArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :event_source_mapping_ref => { kind: :property, name: "eventSourceMappingRef", is_optional: false },
    :function_name => { kind: :property, name: "functionName", is_optional: false },
    :amazon_managed_kafka_event_source_config => { kind: :property, name: "amazonManagedKafkaEventSourceConfig", is_optional: true },
    :batch_size => { kind: :property, name: "batchSize", is_optional: true },
    :bisect_batch_on_function_error => { kind: :property, name: "bisectBatchOnFunctionError", is_optional: true },
    :destination_config => { kind: :property, name: "destinationConfig", is_optional: true },
    :document_db_event_source_config => { kind: :property, name: "documentDbEventSourceConfig", is_optional: true },
    :enabled => { kind: :property, name: "enabled", is_optional: true },
    :event_source_arn => { kind: :property, name: "eventSourceArn", is_optional: true },
    :filter_criteria => { kind: :property, name: "filterCriteria", is_optional: true },
    :function_response_types => { kind: :property, name: "functionResponseTypes", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :logging_config => { kind: :property, name: "loggingConfig", is_optional: true },
    :maximum_batching_window_in_seconds => { kind: :property, name: "maximumBatchingWindowInSeconds", is_optional: true },
    :maximum_record_age_in_seconds => { kind: :property, name: "maximumRecordAgeInSeconds", is_optional: true },
    :maximum_retry_attempts => { kind: :property, name: "maximumRetryAttempts", is_optional: true },
    :metrics_config => { kind: :property, name: "metricsConfig", is_optional: true },
    :parallelization_factor => { kind: :property, name: "parallelizationFactor", is_optional: true },
    :provisioned_poller_config => { kind: :property, name: "provisionedPollerConfig", is_optional: true },
    :queues => { kind: :property, name: "queues", is_optional: true },
    :scaling_config => { kind: :property, name: "scalingConfig", is_optional: true },
    :self_managed_event_source => { kind: :property, name: "selfManagedEventSource", is_optional: true },
    :self_managed_kafka_event_source_config => { kind: :property, name: "selfManagedKafkaEventSourceConfig", is_optional: true },
    :source_access_configurations => { kind: :property, name: "sourceAccessConfigurations", is_optional: true },
    :starting_position => { kind: :property, name: "startingPosition", is_optional: true },
    :starting_position_timestamp => { kind: :property, name: "startingPositionTimestamp", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :topics => { kind: :property, name: "topics", is_optional: true },
    :tumbling_window_in_seconds => { kind: :property, name: "tumblingWindowInSeconds", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



638
639
640
641
 
# File 'lambda/cfn_event_source_mapping.rb', line 638

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



650
651
652
653
 
# File 'lambda/cfn_event_source_mapping.rb', line 650

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



660
661
662
663
 
# File 'lambda/cfn_event_source_mapping.rb', line 660

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



671
672
673
674
675
 
# File 'lambda/cfn_event_source_mapping.rb', line 671

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


728
729
730
731
732
 
# File 'lambda/cfn_event_source_mapping.rb', line 728

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



738
739
740
741
 
# File 'lambda/cfn_event_source_mapping.rb', line 738

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



750
751
752
753
754
 
# File 'lambda/cfn_event_source_mapping.rb', line 750

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#amazon_managed_kafka_event_source_config ⇒ AWSCDK::IResolvable, ...

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

Returns:



266
267
268
 
# File 'lambda/cfn_event_source_mapping.rb', line 266

def amazon_managed_kafka_event_source_config()
  jsii_get_property("amazonManagedKafkaEventSourceConfig")
end

#amazon_managed_kafka_event_source_config=(value) ⇒ Object 



270
271
272
273
274
 
# File 'lambda/cfn_event_source_mapping.rb', line 270

def amazon_managed_kafka_event_source_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::AmazonManagedKafkaEventSourceConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLkFtYXpvbk1hbmFnZWRLYWZrYUV2ZW50U291cmNlQ29uZmlnUHJvcGVydHkifV19fQ==")), "amazonManagedKafkaEventSourceConfig") unless value.nil?
  jsii_set_property("amazonManagedKafkaEventSourceConfig", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



763
764
765
766
 
# File 'lambda/cfn_event_source_mapping.rb', line 763

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



785
786
787
788
789
790
 
# File 'lambda/cfn_event_source_mapping.rb', line 785

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_event_source_mapping_arn ⇒ String

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

Returns:

  • (String) 


226
227
228
 
# File 'lambda/cfn_event_source_mapping.rb', line 226

def attr_event_source_mapping_arn()
  jsii_get_property("attrEventSourceMappingArn")
end

#attr_id ⇒ String

The event source mapping's ID.

Returns:

  • (String) 


233
234
235
 
# File 'lambda/cfn_event_source_mapping.rb', line 233

def attr_id()
  jsii_get_property("attrId")
end

#batch_size ⇒ Numeric?

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

Returns:

  • (Numeric, nil) 


279
280
281
 
# File 'lambda/cfn_event_source_mapping.rb', line 279

def batch_size()
  jsii_get_property("batchSize")
end

#batch_size=(value) ⇒ Object 



283
284
285
286
 
# File 'lambda/cfn_event_source_mapping.rb', line 283

def batch_size=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "batchSize") unless value.nil?
  jsii_set_property("batchSize", value)
end

#bisect_batch_on_function_error ⇒ Boolean, ...

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

Returns:



291
292
293
 
# File 'lambda/cfn_event_source_mapping.rb', line 291

def bisect_batch_on_function_error()
  jsii_get_property("bisectBatchOnFunctionError")
end

#bisect_batch_on_function_error=(value) ⇒ Object 



295
296
297
298
 
# File 'lambda/cfn_event_source_mapping.rb', line 295

def bisect_batch_on_function_error=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "bisectBatchOnFunctionError") unless value.nil?
  jsii_set_property("bisectBatchOnFunctionError", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
 
# File 'lambda/cfn_event_source_mapping.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



172
173
174
 
# File 'lambda/cfn_event_source_mapping.rb', line 172

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'lambda/cfn_event_source_mapping.rb', line 177

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


794
795
796
797
 
# File 'lambda/cfn_event_source_mapping.rb', line 794

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


182
183
184
 
# File 'lambda/cfn_event_source_mapping.rb', line 182

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


189
190
191
 
# File 'lambda/cfn_event_source_mapping.rb', line 189

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


134
135
136
 
# File 'lambda/cfn_event_source_mapping.rb', line 134

def creation_stack()
  jsii_get_property("creationStack")
end

#destination_config ⇒ AWSCDK::IResolvable, ...

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

Returns:



303
304
305
 
# File 'lambda/cfn_event_source_mapping.rb', line 303

def destination_config()
  jsii_get_property("destinationConfig")
end

#destination_config=(value) ⇒ Object 



307
308
309
310
311
 
# File 'lambda/cfn_event_source_mapping.rb', line 307

def destination_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::DestinationConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLkRlc3RpbmF0aW9uQ29uZmlnUHJvcGVydHkifV19fQ==")), "destinationConfig") unless value.nil?
  jsii_set_property("destinationConfig", value)
end

#document_db_event_source_config ⇒ AWSCDK::IResolvable, ...

Specific configuration settings for a DocumentDB event source.

Returns:



316
317
318
 
# File 'lambda/cfn_event_source_mapping.rb', line 316

def document_db_event_source_config()
  jsii_get_property("documentDbEventSourceConfig")
end

#document_db_event_source_config=(value) ⇒ Object 



320
321
322
323
324
 
# File 'lambda/cfn_event_source_mapping.rb', line 320

def document_db_event_source_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::DocumentDBEventSourceConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLkRvY3VtZW50REJFdmVudFNvdXJjZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "documentDbEventSourceConfig") unless value.nil?
  jsii_set_property("documentDbEventSourceConfig", value)
end

#enabled ⇒ Boolean, ...

When true, the event source mapping is active.

When false, Lambda pauses polling and invocation.

Returns:



331
332
333
 
# File 'lambda/cfn_event_source_mapping.rb', line 331

def enabled()
  jsii_get_property("enabled")
end

#enabled=(value) ⇒ Object 



335
336
337
338
 
# File 'lambda/cfn_event_source_mapping.rb', line 335

def enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless value.nil?
  jsii_set_property("enabled", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



194
195
196
 
# File 'lambda/cfn_event_source_mapping.rb', line 194

def env()
  jsii_get_property("env")
end

#event_source_arn ⇒ String?

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

Returns:

  • (String, nil) 


343
344
345
 
# File 'lambda/cfn_event_source_mapping.rb', line 343

def event_source_arn()
  jsii_get_property("eventSourceArn")
end

#event_source_arn=(value) ⇒ Object 



347
348
349
350
 
# File 'lambda/cfn_event_source_mapping.rb', line 347

def event_source_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventSourceArn") unless value.nil?
  jsii_set_property("eventSourceArn", value)
end

#event_source_mapping_ref ⇒ AWSCDK::Interfaces::AWSLambda::EventSourceMappingReference

A reference to a EventSourceMapping resource.

Returns:



247
248
249
 
# File 'lambda/cfn_event_source_mapping.rb', line 247

def event_source_mapping_ref()
  jsii_get_property("eventSourceMappingRef")
end

#filter_criteria ⇒ AWSCDK::IResolvable, ...

An object that defines the filter criteria that determine whether Lambda should process an event.

Returns:



355
356
357
 
# File 'lambda/cfn_event_source_mapping.rb', line 355

def filter_criteria()
  jsii_get_property("filterCriteria")
end

#filter_criteria=(value) ⇒ Object 



359
360
361
362
363
 
# File 'lambda/cfn_event_source_mapping.rb', line 359

def filter_criteria=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::FilterCriteriaProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLkZpbHRlckNyaXRlcmlhUHJvcGVydHkifV19fQ==")), "filterCriteria") unless value.nil?
  jsii_set_property("filterCriteria", value)
end

#function_name ⇒ String

The name or ARN of the Lambda function.

Returns:

  • (String) 


254
255
256
 
# File 'lambda/cfn_event_source_mapping.rb', line 254

def function_name()
  jsii_get_property("functionName")
end

#function_name=(value) ⇒ Object 



258
259
260
261
 
# File 'lambda/cfn_event_source_mapping.rb', line 258

def function_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "functionName")
  jsii_set_property("functionName", value)
end

#function_response_types ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


368
369
370
 
# File 'lambda/cfn_event_source_mapping.rb', line 368

def function_response_types()
  jsii_get_property("functionResponseTypes")
end

#function_response_types=(value) ⇒ Object 



372
373
374
375
 
# File 'lambda/cfn_event_source_mapping.rb', line 372

def function_response_types=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "functionResponseTypes") unless value.nil?
  jsii_set_property("functionResponseTypes", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



807
808
809
810
811
 
# File 'lambda/cfn_event_source_mapping.rb', line 807

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



818
819
820
821
 
# File 'lambda/cfn_event_source_mapping.rb', line 818

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



888
889
890
891
 
# File 'lambda/cfn_event_source_mapping.rb', line 888

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_arn ⇒ String?

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

Returns:

  • (String, nil) 


380
381
382
 
# File 'lambda/cfn_event_source_mapping.rb', line 380

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



384
385
386
387
 
# File 'lambda/cfn_event_source_mapping.rb', line 384

def kms_key_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless value.nil?
  jsii_set_property("kmsKeyArn", value)
end

#logging_config ⇒ AWSCDK::IResolvable, ...

The function's Amazon CloudWatch Logs configuration settings.

Returns:



392
393
394
 
# File 'lambda/cfn_event_source_mapping.rb', line 392

def logging_config()
  jsii_get_property("loggingConfig")
end

#logging_config=(value) ⇒ Object 



396
397
398
399
400
 
# File 'lambda/cfn_event_source_mapping.rb', line 396

def logging_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::LoggingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLkxvZ2dpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "loggingConfig") unless value.nil?
  jsii_set_property("loggingConfig", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


146
147
148
 
# File 'lambda/cfn_event_source_mapping.rb', line 146

def logical_id()
  jsii_get_property("logicalId")
end

#maximum_batching_window_in_seconds ⇒ Numeric?

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Returns:

  • (Numeric, nil) 


405
406
407
 
# File 'lambda/cfn_event_source_mapping.rb', line 405

def maximum_batching_window_in_seconds()
  jsii_get_property("maximumBatchingWindowInSeconds")
end

#maximum_batching_window_in_seconds=(value) ⇒ Object 



409
410
411
412
 
# File 'lambda/cfn_event_source_mapping.rb', line 409

def maximum_batching_window_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumBatchingWindowInSeconds") unless value.nil?
  jsii_set_property("maximumBatchingWindowInSeconds", value)
end

#maximum_record_age_in_seconds ⇒ Numeric?

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age.

Returns:

  • (Numeric, nil) 


417
418
419
 
# File 'lambda/cfn_event_source_mapping.rb', line 417

def maximum_record_age_in_seconds()
  jsii_get_property("maximumRecordAgeInSeconds")
end

#maximum_record_age_in_seconds=(value) ⇒ Object 



421
422
423
424
 
# File 'lambda/cfn_event_source_mapping.rb', line 421

def maximum_record_age_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumRecordAgeInSeconds") unless value.nil?
  jsii_set_property("maximumRecordAgeInSeconds", value)
end

#maximum_retry_attempts ⇒ Numeric?

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries.

Returns:

  • (Numeric, nil) 


429
430
431
 
# File 'lambda/cfn_event_source_mapping.rb', line 429

def maximum_retry_attempts()
  jsii_get_property("maximumRetryAttempts")
end

#maximum_retry_attempts=(value) ⇒ Object 



433
434
435
436
 
# File 'lambda/cfn_event_source_mapping.rb', line 433

def maximum_retry_attempts=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumRetryAttempts") unless value.nil?
  jsii_set_property("maximumRetryAttempts", value)
end

#metrics_config ⇒ AWSCDK::IResolvable, ...

The metrics configuration for your event source.

Returns:



441
442
443
 
# File 'lambda/cfn_event_source_mapping.rb', line 441

def metrics_config()
  jsii_get_property("metricsConfig")
end

#metrics_config=(value) ⇒ Object 



445
446
447
448
449
 
# File 'lambda/cfn_event_source_mapping.rb', line 445

def metrics_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::MetricsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLk1ldHJpY3NDb25maWdQcm9wZXJ0eSJ9XX19")), "metricsConfig") unless value.nil?
  jsii_set_property("metricsConfig", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


129
130
131
 
# File 'lambda/cfn_event_source_mapping.rb', line 129

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



829
830
831
 
# File 'lambda/cfn_event_source_mapping.rb', line 829

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



836
837
838
 
# File 'lambda/cfn_event_source_mapping.rb', line 836

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



629
630
631
632
 
# File 'lambda/cfn_event_source_mapping.rb', line 629

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#parallelization_factor ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


454
455
456
 
# File 'lambda/cfn_event_source_mapping.rb', line 454

def parallelization_factor()
  jsii_get_property("parallelizationFactor")
end

#parallelization_factor=(value) ⇒ Object 



458
459
460
461
 
# File 'lambda/cfn_event_source_mapping.rb', line 458

def parallelization_factor=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "parallelizationFactor") unless value.nil?
  jsii_set_property("parallelizationFactor", value)
end

#provisioned_poller_config ⇒ AWSCDK::IResolvable, ...

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

Returns:



466
467
468
 
# File 'lambda/cfn_event_source_mapping.rb', line 466

def provisioned_poller_config()
  jsii_get_property("provisionedPollerConfig")
end

#provisioned_poller_config=(value) ⇒ Object 



470
471
472
473
474
 
# File 'lambda/cfn_event_source_mapping.rb', line 470

def provisioned_poller_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::ProvisionedPollerConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLlByb3Zpc2lvbmVkUG9sbGVyQ29uZmlnUHJvcGVydHkifV19fQ==")), "provisionedPollerConfig") unless value.nil?
  jsii_set_property("provisionedPollerConfig", value)
end

#queues ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


479
480
481
 
# File 'lambda/cfn_event_source_mapping.rb', line 479

def queues()
  jsii_get_property("queues")
end

#queues=(value) ⇒ Object 



483
484
485
486
 
# File 'lambda/cfn_event_source_mapping.rb', line 483

def queues=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "queues") unless value.nil?
  jsii_set_property("queues", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


165
166
167
 
# File 'lambda/cfn_event_source_mapping.rb', line 165

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



847
848
849
850
 
# File 'lambda/cfn_event_source_mapping.rb', line 847

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


854
855
856
857
 
# File 'lambda/cfn_event_source_mapping.rb', line 854

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



864
865
866
867
868
 
# File 'lambda/cfn_event_source_mapping.rb', line 864

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scaling_config ⇒ AWSCDK::IResolvable, ...

This property is for Amazon SQS event sources only.

Returns:



491
492
493
 
# File 'lambda/cfn_event_source_mapping.rb', line 491

def scaling_config()
  jsii_get_property("scalingConfig")
end

#scaling_config=(value) ⇒ Object 



495
496
497
498
499
 
# File 'lambda/cfn_event_source_mapping.rb', line 495

def scaling_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::ScalingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLlNjYWxpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "scalingConfig") unless value.nil?
  jsii_set_property("scalingConfig", value)
end

#self_managed_event_source ⇒ AWSCDK::IResolvable, ...

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

Returns:



504
505
506
 
# File 'lambda/cfn_event_source_mapping.rb', line 504

def self_managed_event_source()
  jsii_get_property("selfManagedEventSource")
end

#self_managed_event_source=(value) ⇒ Object 



508
509
510
511
512
 
# File 'lambda/cfn_event_source_mapping.rb', line 508

def self_managed_event_source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::SelfManagedEventSourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLlNlbGZNYW5hZ2VkRXZlbnRTb3VyY2VQcm9wZXJ0eSJ9XX19")), "selfManagedEventSource") unless value.nil?
  jsii_set_property("selfManagedEventSource", value)
end

#self_managed_kafka_event_source_config ⇒ AWSCDK::IResolvable, ...

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

Returns:



517
518
519
 
# File 'lambda/cfn_event_source_mapping.rb', line 517

def self_managed_kafka_event_source_config()
  jsii_get_property("selfManagedKafkaEventSourceConfig")
end

#self_managed_kafka_event_source_config=(value) ⇒ Object 



521
522
523
524
525
 
# File 'lambda/cfn_event_source_mapping.rb', line 521

def self_managed_kafka_event_source_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventSourceMapping::SelfManagedKafkaEventSourceConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRTb3VyY2VNYXBwaW5nLlNlbGZNYW5hZ2VkS2Fma2FFdmVudFNvdXJjZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "selfManagedKafkaEventSourceConfig") unless value.nil?
  jsii_set_property("selfManagedKafkaEventSourceConfig", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



873
874
875
 
# File 'lambda/cfn_event_source_mapping.rb', line 873

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_access_configurations ⇒ AWSCDK::IResolvable, ...

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

Returns:



530
531
532
 
# File 'lambda/cfn_event_source_mapping.rb', line 530

def source_access_configurations()
  jsii_get_property("sourceAccessConfigurations")
end

#source_access_configurations=(value) ⇒ Object 



534
535
536
537
 
# File 'lambda/cfn_event_source_mapping.rb', line 534

def source_access_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLkNmbkV2ZW50U291cmNlTWFwcGluZy5Tb3VyY2VBY2Nlc3NDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "sourceAccessConfigurations") unless value.nil?
  jsii_set_property("sourceAccessConfigurations", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



155
156
157
 
# File 'lambda/cfn_event_source_mapping.rb', line 155

def stack()
  jsii_get_property("stack")
end

#starting_position ⇒ String?

The position in a stream from which to start reading.

Required for Amazon Kinesis and Amazon DynamoDB.

Returns:

  • (String, nil) 


544
545
546
 
# File 'lambda/cfn_event_source_mapping.rb', line 544

def starting_position()
  jsii_get_property("startingPosition")
end

#starting_position=(value) ⇒ Object 



548
549
550
551
 
# File 'lambda/cfn_event_source_mapping.rb', line 548

def starting_position=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startingPosition") unless value.nil?
  jsii_set_property("startingPosition", value)
end

#starting_position_timestamp ⇒ Numeric?

With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

Returns:

  • (Numeric, nil) 


556
557
558
 
# File 'lambda/cfn_event_source_mapping.rb', line 556

def starting_position_timestamp()
  jsii_get_property("startingPositionTimestamp")
end

#starting_position_timestamp=(value) ⇒ Object 



560
561
562
563
 
# File 'lambda/cfn_event_source_mapping.rb', line 560

def starting_position_timestamp=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "startingPositionTimestamp") unless value.nil?
  jsii_set_property("startingPositionTimestamp", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags to add to the event source mapping.

Returns:



568
569
570
 
# File 'lambda/cfn_event_source_mapping.rb', line 568

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



572
573
574
575
576
 
# File 'lambda/cfn_event_source_mapping.rb', line 572

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



605
606
607
 
# File 'lambda/cfn_event_source_mapping.rb', line 605

def to_string()
  jsii_call_method("toString", [])
end

#topics ⇒ Array<String>?

The name of the Kafka topic.

Returns:

  • (Array<String>, nil) 


581
582
583
 
# File 'lambda/cfn_event_source_mapping.rb', line 581

def topics()
  jsii_get_property("topics")
end

#topics=(value) ⇒ Object 



585
586
587
588
 
# File 'lambda/cfn_event_source_mapping.rb', line 585

def topics=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "topics") unless value.nil?
  jsii_set_property("topics", value)
end

#tumbling_window_in_seconds ⇒ Numeric?

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

Returns:

  • (Numeric, nil) 


593
594
595
 
# File 'lambda/cfn_event_source_mapping.rb', line 593

def tumbling_window_in_seconds()
  jsii_get_property("tumblingWindowInSeconds")
end

#tumbling_window_in_seconds=(value) ⇒ Object 



597
598
599
600
 
# File 'lambda/cfn_event_source_mapping.rb', line 597

def tumbling_window_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "tumblingWindowInSeconds") unless value.nil?
  jsii_set_property("tumblingWindowInSeconds", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'lambda/cfn_event_source_mapping.rb', line 202

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


212
213
214
 
# File 'lambda/cfn_event_source_mapping.rb', line 212

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


879
880
881
882
 
# File 'lambda/cfn_event_source_mapping.rb', line 879

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


618
619
620
621
622
623
 
# File 'lambda/cfn_event_source_mapping.rb', line 618

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end