Package software.amazon.awscdk.services.events.targets

Class CloudWatchLogGroup.Builder

java.lang.Object
software.amazon.awscdk.services.events.targets.CloudWatchLogGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CloudWatchLogGroup>
Enclosing class:
CloudWatchLogGroup
@Stability(Stable) public static final class CloudWatchLogGroup.Builder extends Object implements software.amazon.jsii.Builder<CloudWatchLogGroup>
A fluent builder for CloudWatchLogGroup.

  • Method Details

    • create

      @Stability(Stable) public static CloudWatchLogGroup.Builder create(ILogGroup logGroup)
      Parameters:
      logGroup - This parameter is required.
      Returns:
      a new instance of CloudWatchLogGroup.Builder.

    • deadLetterQueue

      @Stability(Stable) public CloudWatchLogGroup.Builder deadLetterQueue(IQueue deadLetterQueue)
      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

      Parameters:
      deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. This parameter is required.
      Returns:
      this

    • maxEventAge

      @Stability(Stable) public CloudWatchLogGroup.Builder maxEventAge(Duration maxEventAge)
      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)

      Parameters:
      maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.
      Returns:
      this

    • retryAttempts

      @Stability(Stable) public CloudWatchLogGroup.Builder retryAttempts(Number retryAttempts)
      The maximum number of times to retry when the function returns an error.

      Minimum value of 0. Maximum value of 185.

      Default: 185

      Parameters:
      retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.
      Returns:
      this

    • event

      @Stability(Deprecated) @Deprecated public CloudWatchLogGroup.Builder event(RuleTargetInput event)
      Deprecated.
      use logEvent instead
      (deprecated) The event to send to the CloudWatch LogGroup.

      This will be the event logged into the CloudWatch LogGroup

      Default: - the entire EventBridge event

      Parameters:
      event - The event to send to the CloudWatch LogGroup. This parameter is required.
      Returns:
      this

    • installLatestAwsSdk

      @Stability(Stable) public CloudWatchLogGroup.Builder installLatestAwsSdk(Boolean installLatestAwsSdk)
      Whether the custom resource created wll default to install latest AWS SDK.

      Default: - install latest AWS SDK

      Parameters:
      installLatestAwsSdk - Whether the custom resource created wll default to install latest AWS SDK. This parameter is required.
      Returns:
      this

    • logEvent

      @Stability(Stable) public CloudWatchLogGroup.Builder logEvent(LogGroupTargetInput logEvent)
      The event to send to the CloudWatch LogGroup.

      This will be the event logged into the CloudWatch LogGroup

      Default: - the entire EventBridge event

      Parameters:
      logEvent - The event to send to the CloudWatch LogGroup. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CloudWatchLogGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CloudWatchLogGroup>
      Returns:
      a newly built instance of CloudWatchLogGroup.