Class: AWSCDK::Lambda::ProvisionedPollerConfig

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

Overview

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

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) ⇒ ProvisionedPollerConfig

Returns a new instance of ProvisionedPollerConfig.

Parameters:

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

    The maximum number of pollers that can be provisioned.

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

    The minimum number of pollers that should be provisioned.

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

    An optional identifier that groups multiple ESMs to share EPU capacity and reduce costs.



10
11
12
13
14
15
16
17
 
# File 'lambda/provisioned_poller_config.rb', line 10

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)

Note:

Default: 200

The maximum number of pollers that can be provisioned.

Valid Range:

  • For Amazon SQS: Minimum value of 2. Maximum value of 2000. Default: 200.
  • For Amazon MSK, self-managed Apache Kafka, and Amazon MQ: Minimum value of 1. Maximum value of 2000. Default: 200.

Returns:

  • (Numeric, nil) 


28
29
30
 
# File 'lambda/provisioned_poller_config.rb', line 28

def maximum_pollers
  @maximum_pollers
end

#minimum_pollers ⇒ Numeric? (readonly)

Note:

Default: - 2 for SQS, 1 for MSK/Kafka/MQ

The minimum number of pollers that should be provisioned.

Valid Range:

  • For Amazon SQS: Minimum value of 2. Maximum value of 200. Default: 2.
  • For Amazon MSK, self-managed Apache Kafka, and Amazon MQ: Minimum value of 1. Maximum value of 200. Default: 1.

Returns:

  • (Numeric, nil) 


38
39
40
 
# File 'lambda/provisioned_poller_config.rb', line 38

def minimum_pollers
  @minimum_pollers
end

#poller_group_name ⇒ String? (readonly)

Note:

Default: - not set, dedicated compute resource per event source.

An optional identifier that groups multiple ESMs to share EPU capacity and reduce costs.

ESMs with the same PollerGroupName share compute resources.

Returns:

  • (String, nil) 


46
47
48
 
# File 'lambda/provisioned_poller_config.rb', line 46

def poller_group_name
  @poller_group_name
end

Class Method Details

.jsii_properties ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lambda/provisioned_poller_config.rb', line 48

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

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lambda/provisioned_poller_config.rb', line 56

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