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

Class PutSubscriptionFilterRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

@Generated("software.amazon.awssdk:codegen")
public class PutSubscriptionFilterRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutSubscriptionFilterRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static PutSubscriptionFilterRequest.Builder	builder()
String	destinationArn()	The ARN of the destination to deliver matching log events to.
String	distribution()	The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream.
boolean	equals(Object obj)
String	filterName()	A name for the subscription filter.
String	filterPattern()	A filter pattern for subscribing to a filtered stream of log events.
int	hashCode()
String	logGroupName()	The name of the log group.
String	roleArn()	The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.
static Class<? extends PutSubscriptionFilterRequest.Builder>	serializableBuilderClass()
PutSubscriptionFilterRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

logGroupName

public String logGroupName()

The name of the log group.

Returns:

The name of the log group.

filterName

public 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.

Returns:

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.

filterPattern

public String filterPattern()

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

Returns:

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

destinationArn

public 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.

Returns:

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.

roleArn

public 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.

Returns:

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.

distribution

public 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.

Returns:

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.

See Also:

Distribution

toBuilder

public PutSubscriptionFilterRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

Returns:

a builder for type T

builder

public static PutSubscriptionFilterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutSubscriptionFilterRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object