Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface PutSubscriptionFilterRequest.Builder

    • Method Detail

      • logGroupName

        PutSubscriptionFilterRequest.Builder logGroupName​(String logGroupName)

        The name of the log group.

        Parameters:
        logGroupName - The name of the log group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterName

        PutSubscriptionFilterRequest.Builder filterName​(String filterName)

        A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

        Parameters:
        filterName - A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterPattern

        PutSubscriptionFilterRequest.Builder filterPattern​(String filterPattern)

        A filter pattern for subscribing to a filtered stream of log events.

        Parameters:
        filterPattern - A filter pattern for subscribing to a filtered stream of log events.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationArn

        PutSubscriptionFilterRequest.Builder destinationArn​(String destinationArn)

        The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

        • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

        • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

          If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

        • A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

        • A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

        Parameters:
        destinationArn - The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

        • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

        • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

          If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

        • A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

        • A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        PutSubscriptionFilterRequest.Builder roleArn​(String roleArn)

        The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

        Parameters:
        roleArn - The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • distribution

        PutSubscriptionFilterRequest.Builder distribution​(String distribution)

        The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.

        Parameters:
        distribution - The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Distribution, Distribution

      • distribution

        PutSubscriptionFilterRequest.Builder distribution​(Distribution distribution)

        The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.

        Parameters:
        distribution - The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Distribution, Distribution

      • applyOnTransformedLogs

        PutSubscriptionFilterRequest.Builder applyOnTransformedLogs​(Boolean applyOnTransformedLogs)

        This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

        If the log group uses either a log-group level or account-level transformer, and you specify true, the subscription filter will be applied on the transformed version of the log events instead of the original ingested log events.

        Parameters:
        applyOnTransformedLogs - This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

        If the log group uses either a log-group level or account-level transformer, and you specify true, the subscription filter will be applied on the transformed version of the log events instead of the original ingested log events.

        Returns:
        Returns a reference to this object so that method calls can be chained together.