Package software.amazon.awscdk.services.logs

Class SubscriptionFilter.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static SubscriptionFilter.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of SubscriptionFilter.Builder.

    • destination

      @Stability(Stable) public SubscriptionFilter.Builder destination(ILogSubscriptionDestination destination)
      The destination to send the filtered events to.

      For example, a Kinesis stream or a Lambda function.

      Parameters:
      destination - The destination to send the filtered events to. This parameter is required.
      Returns:
      this

    • filterPattern

      @Stability(Stable) public SubscriptionFilter.Builder filterPattern(IFilterPattern filterPattern)
      Log events matching this pattern will be sent to the destination.

      Parameters:
      filterPattern - Log events matching this pattern will be sent to the destination. This parameter is required.
      Returns:
      this

    • distribution

      @Stability(Stable) public SubscriptionFilter.Builder distribution(Distribution distribution)
      The method used to distribute log data to the destination.

      This property can only be used with KinesisDestination.

      Default: Distribution.BY_LOG_STREAM

      Parameters:
      distribution - The method used to distribute log data to the destination. This parameter is required.
      Returns:
      this

    • filterName

      @Stability(Stable) public SubscriptionFilter.Builder filterName(String filterName)
      The name of the subscription filter.

      Default: Automatically generated

      Parameters:
      filterName - The name of the subscription filter. This parameter is required.
      Returns:
      this

    • logGroup

      @Stability(Stable) public SubscriptionFilter.Builder logGroup(ILogGroup logGroup)
      The log group to create the subscription on.

      Parameters:
      logGroup - The log group to create the subscription on. This parameter is required.
      Returns:
      this

    • build

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