Interface TargetBaseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
ApiDestinationProps
,ApiGatewayProps
,AppSyncGraphQLApiProps
,BatchJobProps
,CodeBuildProjectProps
,CodePipelineTargetOptions
,EcsTaskProps
,KinesisStreamProps
,LambdaFunctionProps
,LogGroupProps
,SfnStateMachineProps
,SnsTopicProps
,SqsQueueProps
- All Known Implementing Classes:
ApiDestinationProps.Jsii$Proxy
,ApiGatewayProps.Jsii$Proxy
,AppSyncGraphQLApiProps.Jsii$Proxy
,BatchJobProps.Jsii$Proxy
,CodeBuildProjectProps.Jsii$Proxy
,CodePipelineTargetOptions.Jsii$Proxy
,EcsTaskProps.Jsii$Proxy
,KinesisStreamProps.Jsii$Proxy
,LambdaFunctionProps.Jsii$Proxy
,LogGroupProps.Jsii$Proxy
,SfnStateMachineProps.Jsii$Proxy
,SnsTopicProps.Jsii$Proxy
,SqsQueueProps.Jsii$Proxy
,TargetBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:43.746Z")
@Stability(Stable)
public interface TargetBaseProps
extends software.amazon.jsii.JsiiSerializable
The generic properties for an RuleTarget.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.*; import software.amazon.awscdk.services.events.targets.*; import software.amazon.awscdk.services.sqs.*; Queue queue; TargetBaseProps targetBaseProps = TargetBaseProps.builder() .deadLetterQueue(queue) .maxEventAge(Duration.minutes(30)) .retryAttempts(123) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forTargetBaseProps
static final class
An implementation forTargetBaseProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic TargetBaseProps.Builder
builder()
default IQueue
The SQS queue to be used as deadLetterQueue.default Duration
The maximum age of a request that Lambda sends to a function for processing.default Number
The maximum number of times to retry when the function returns an error.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeadLetterQueue
The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.
Default: - no dead-letter queue
-
getMaxEventAge
The maximum age of a request that Lambda sends to a function for processing.Minimum value of 60. Maximum value of 86400.
Default: Duration.hours(24)
-
getRetryAttempts
The maximum number of times to retry when the function returns an error.Minimum value of 0. Maximum value of 185.
Default: 185
-
builder
- Returns:
- a
TargetBaseProps.Builder
ofTargetBaseProps
-