Class: AWSCDK::Lambda::CfnEventSourceMapping::ProvisionedPollerConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lambda/cfn_event_source_mapping.rb

Overview

The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(maximum_pollers: nil, minimum_pollers: nil, poller_group_name: nil) ⇒ ProvisionedPollerConfigProperty

Returns a new instance of ProvisionedPollerConfigProperty.

Parameters:

  • maximum_pollers (Numeric, nil) (defaults to: nil) —

    The maximum number of event pollers this event source can scale up to.

  • minimum_pollers (Numeric, nil) (defaults to: nil) —

    The minimum number of event pollers this event source can scale down to.

  • poller_group_name (String, nil) (defaults to: nil) —

    (Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group.



1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lambda/cfn_event_source_mapping.rb', line 1255

def initialize(maximum_pollers: nil, minimum_pollers: nil, poller_group_name: nil)
  @maximum_pollers = maximum_pollers
  Jsii::Type.check_type(@maximum_pollers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumPollers") unless @maximum_pollers.nil?
  @minimum_pollers = minimum_pollers
  Jsii::Type.check_type(@minimum_pollers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimumPollers") unless @minimum_pollers.nil?
  @poller_group_name = poller_group_name
  Jsii::Type.check_type(@poller_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pollerGroupName") unless @poller_group_name.nil?
end

Instance Attribute Details

#maximum_pollers ⇒ Numeric? (readonly)

The maximum number of event pollers this event source can scale up to.

For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.

Returns:

  • (Numeric, nil)

See Also:



1270
1271
1272
 
# File 'lambda/cfn_event_source_mapping.rb', line 1270

def maximum_pollers
  @maximum_pollers
end

#minimum_pollers ⇒ Numeric? (readonly)

The minimum number of event pollers this event source can scale down to.

For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.

Returns:

  • (Numeric, nil)

See Also:



1277
1278
1279
 
# File 'lambda/cfn_event_source_mapping.rb', line 1277

def minimum_pollers
  @minimum_pollers
end

#poller_group_name ⇒ String? (readonly)

(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group.

Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.

Returns:

  • (String, nil)

See Also:



1284
1285
1286
 
# File 'lambda/cfn_event_source_mapping.rb', line 1284

def poller_group_name
  @poller_group_name
end

Class Method Details

.jsii_properties ⇒ Object 



1286
1287
1288
1289
1290
1291
1292
 
# File 'lambda/cfn_event_source_mapping.rb', line 1286

def self.jsii_properties
  {
    :maximum_pollers => "maximumPollers",
    :minimum_pollers => "minimumPollers",
    :poller_group_name => "pollerGroupName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'lambda/cfn_event_source_mapping.rb', line 1294

def to_jsii
  result = {}
  result.merge!({
    "maximumPollers" => @maximum_pollers,
    "minimumPollers" => @minimum_pollers,
    "pollerGroupName" => @poller_group_name,
  })
  result.compact
end