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

Interface PutSubscriptionFilterRequest.Builder

All Superinterfaces:

CopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>, SdkBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

Enclosing class:

PutSubscriptionFilterRequest

public static interface PutSubscriptionFilterRequest.Builder
extends CopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

Method Summary

Modifier and Type	Method	Description
PutSubscriptionFilterRequest.Builder	destinationArn(String destinationArn)	The ARN of the destination to deliver matching log events to.
PutSubscriptionFilterRequest.Builder	distribution(String distribution)	The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream.
PutSubscriptionFilterRequest.Builder	distribution(Distribution distribution)	The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream.
PutSubscriptionFilterRequest.Builder	filterName(String filterName)	A name for the subscription filter.
PutSubscriptionFilterRequest.Builder	filterPattern(String filterPattern)	A filter pattern for subscribing to a filtered stream of log events.
PutSubscriptionFilterRequest.Builder	logGroupName(String logGroupName)	The name of the log group.
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.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

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. Otherwise, the call will fail because you cannot associate a second filter with a log group. 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. Otherwise, the call will fail because you cannot associate a second filter with a log group. 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.

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

• An AWS 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.

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

• An AWS 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, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.

Parameters:

distribution - The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.

Returns:

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

See Also:

Distribution

distribution

PutSubscriptionFilterRequest.Builder distribution(Distribution distribution)

The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.

Parameters:

distribution - The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.

Returns:

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

See Also:

Distribution