Class CfnEventInvokeConfig
A CloudFormation AWS::Lambda::EventInvokeConfig
.
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.AWS.Lambda.dll
Syntax (csharp)
public class CfnEventInvokeConfig : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEventInvokeConfig
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Lambda::EventInvokeConfig
resource configures options for asynchronous invocation on a version or an alias.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it.
CloudformationResource: AWS::Lambda::EventInvokeConfig
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;
var cfnEventInvokeConfig = new CfnEventInvokeConfig(this, "MyCfnEventInvokeConfig", new CfnEventInvokeConfigProps {
FunctionName = "functionName",
Qualifier = "qualifier",
// the properties below are optional
DestinationConfig = new DestinationConfigProperty {
OnFailure = new OnFailureProperty {
Destination = "destination"
},
OnSuccess = new OnSuccessProperty {
Destination = "destination"
}
},
MaximumEventAgeInSeconds = 123,
MaximumRetryAttempts = 123
});
Synopsis
Constructors
CfnEventInvokeConfig(Construct, String, ICfnEventInvokeConfigProps) | Create a new |
CfnEventInvokeConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEventInvokeConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DestinationConfig | A destination for events after they have been sent to a function for processing. |
FunctionName | The name of the Lambda function. |
MaximumEventAgeInSeconds | The maximum age of a request that Lambda sends to a function for processing. |
MaximumRetryAttempts | The maximum number of times to retry when the function returns an error. |
Qualifier | The identifier of a version or alias. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventInvokeConfig(Construct, String, ICfnEventInvokeConfigProps)
Create a new AWS::Lambda::EventInvokeConfig
.
public CfnEventInvokeConfig(Construct scope, string id, ICfnEventInvokeConfigProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEventInvokeConfigProps
- resource properties.
CfnEventInvokeConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEventInvokeConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEventInvokeConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEventInvokeConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DestinationConfig
A destination for events after they have been sent to a function for processing.
public virtual object DestinationConfig { get; set; }
Property Value
System.Object
Remarks
Destinations - Function - The Amazon Resource Name (ARN) of a Lambda function.
FunctionName
The name of the Lambda function.
public virtual string FunctionName { get; set; }
Property Value
System.String
Remarks
Minimum : 1
Maximum : 64
Pattern : ([a-zA-Z0-9-_]+)
MaximumEventAgeInSeconds
The maximum age of a request that Lambda sends to a function for processing.
public virtual Nullable<double> MaximumEventAgeInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
MaximumRetryAttempts
The maximum number of times to retry when the function returns an error.
public virtual Nullable<double> MaximumRetryAttempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Qualifier
The identifier of a version or alias.
public virtual string Qualifier { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>