Interface TargetBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ApiDestinationProps, ApiGatewayProps, AppSyncGraphQLApiProps, BatchJobProps, CodeBuildProjectProps, CodePipelineTargetOptions, EcsTaskProps, 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, LambdaFunctionProps.Jsii$Proxy, LogGroupProps.Jsii$Proxy, SfnStateMachineProps.Jsii$Proxy, SnsTopicProps.Jsii$Proxy, SqsQueueProps.Jsii$Proxy, TargetBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-30T02:11:07.752Z") @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();
 
  • Method Details

    • getDeadLetterQueue

      @Stability(Stable) @Nullable default IQueue 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

      @Stability(Stable) @Nullable default Duration 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

      @Stability(Stable) @Nullable default Number 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

      @Stability(Stable) static TargetBaseProps.Builder builder()
      Returns:
      a TargetBaseProps.Builder of TargetBaseProps