Class: AWSCDK::Lambda::CfnEventInvokeConfigProps

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

Overview

Properties for defining a CfnEventInvokeConfig.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(function_name:, qualifier:, destination_config: nil, maximum_event_age_in_seconds: nil, maximum_retry_attempts: nil) ⇒ CfnEventInvokeConfigProps

Returns a new instance of CfnEventInvokeConfigProps.

Parameters:

  • function_name (String, AWSCDK::Interfaces::AWSLambda::IFunctionRef) —

    The name of the Lambda function.

  • qualifier (String) —

    The identifier of a version or alias.

  • destination_config (AWSCDK::IResolvable, AWSCDK::Lambda::CfnEventInvokeConfig::DestinationConfigProperty, nil) (defaults to: nil) —

    A destination for events after they have been sent to a function for processing.

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

    The maximum age of a request that Lambda sends to a function for processing.

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

    The maximum number of times to retry when the function returns an error.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 14

def initialize(function_name:, qualifier:, destination_config: nil, maximum_event_age_in_seconds: nil, maximum_retry_attempts: nil)
  @function_name = function_name
  Jsii::Type.check_type(@function_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sYW1iZGEuSUZ1bmN0aW9uUmVmIn1dfX0=")), "functionName")
  @qualifier = qualifier
  Jsii::Type.check_type(@qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "qualifier")
  @destination_config = destination_config.is_a?(Hash) ? ::AWSCDK::Lambda::CfnEventInvokeConfig::DestinationConfigProperty.new(**destination_config.transform_keys(&:to_sym)) : destination_config
  Jsii::Type.check_type(@destination_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sYW1iZGEuQ2ZuRXZlbnRJbnZva2VDb25maWcuRGVzdGluYXRpb25Db25maWdQcm9wZXJ0eSJ9XX19")), "destinationConfig") unless @destination_config.nil?
  @maximum_event_age_in_seconds = maximum_event_age_in_seconds
  Jsii::Type.check_type(@maximum_event_age_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumEventAgeInSeconds") unless @maximum_event_age_in_seconds.nil?
  @maximum_retry_attempts = maximum_retry_attempts
  Jsii::Type.check_type(@maximum_retry_attempts, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumRetryAttempts") unless @maximum_retry_attempts.nil?
end

Instance Attribute Details

#destination_config ⇒ AWSCDK::IResolvable, ... (readonly)

A destination for events after they have been sent to a function for processing.

Destinations - Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.
  • Bucket - The ARN of an Amazon S3 bucket.
  • Topic - The ARN of a standard SNS topic.
  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

Returns:

See Also:



60
61
62
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 60

def destination_config
  @destination_config
end

#function_name ⇒ String, AWSCDK::Interfaces::AWSLambda::IFunctionRef (readonly)

The name of the Lambda function.

Minimum : 1

Maximum : 64

Pattern : ([a-zA-Z0-9-_]+)

Returns:

See Also:



37
38
39
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 37

def function_name
  @function_name
end

#maximum_event_age_in_seconds ⇒ Numeric? (readonly)

The maximum age of a request that Lambda sends to a function for processing.

Returns:

  • (Numeric, nil)

See Also:



65
66
67
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 65

def maximum_event_age_in_seconds
  @maximum_event_age_in_seconds
end

#maximum_retry_attempts ⇒ Numeric? (readonly)

The maximum number of times to retry when the function returns an error.

Returns:

  • (Numeric, nil)

See Also:



70
71
72
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 70

def maximum_retry_attempts
  @maximum_retry_attempts
end

#qualifier ⇒ String (readonly)

The identifier of a version or alias.

  • Version - A version number.
  • Alias - An alias name.
  • Latest - To specify the unpublished version, use $LATEST .

Returns:

  • (String)

See Also:



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

def qualifier
  @qualifier
end

Class Method Details

.jsii_properties ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 72

def self.jsii_properties
  {
    :function_name => "functionName",
    :qualifier => "qualifier",
    :destination_config => "destinationConfig",
    :maximum_event_age_in_seconds => "maximumEventAgeInSeconds",
    :maximum_retry_attempts => "maximumRetryAttempts",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lambda/cfn_event_invoke_config_props.rb', line 82

def to_jsii
  result = {}
  result.merge!({
    "functionName" => @function_name,
    "qualifier" => @qualifier,
    "destinationConfig" => @destination_config,
    "maximumEventAgeInSeconds" => @maximum_event_age_in_seconds,
    "maximumRetryAttempts" => @maximum_retry_attempts,
  })
  result.compact
end