software.amazon.awssdk.services.cloudwatchlogs.model

Class PutSubscriptionFilterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutSubscriptionFilterRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutSubscriptionFilterRequest.Builder	builder()
String	destinationArn() The ARN of the destination to deliver matching log events to.
Distribution	distribution() The method used to distribute log data to the destination.
String	distributionAsString() The method used to distribute log data to the destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterName() A name for the subscription filter.
String	filterPattern() A filter pattern for subscribing to a filtered stream of log events.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends PutSubscriptionFilterRequest.Builder>	serializableBuilderClass()
PutSubscriptionFilterRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

filterName

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

Returns:

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.

filterPattern

public final 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 final 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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• An Amazon Kinesis 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:

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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• An Amazon Kinesis 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.

roleArn

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

If the service returns an enum value that is not available in the current SDK version, distribution will return Distribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionAsString().

Returns:

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

See Also:

Distribution

distributionAsString

public final String distributionAsString()

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

If the service returns an enum value that is not available in the current SDK version, distribution will return Distribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionAsString().

Returns:

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

See Also:

Distribution

toBuilder

public PutSubscriptionFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutSubscriptionFilterRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo