com.amazonaws.services.logs.model

Class PutSubscriptionFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutSubscriptionFilterRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PutSubscriptionFilterRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. 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 that belongs to a different account, for cross-account delivery.

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

• An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutSubscriptionFilterRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDestinationArn() The ARN of the destination to deliver matching log events to.
java.lang.String	getDistribution() The method used to distribute log data to the destination.
java.lang.String	getFilterName() A name for the subscription filter.
java.lang.String	getFilterPattern() A filter pattern for subscribing to a filtered stream of log events.
java.lang.String	getLogGroupName() The name of the log group.
java.lang.String	getRoleArn() The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.
int	hashCode()
void	setDestinationArn(java.lang.String destinationArn) The ARN of the destination to deliver matching log events to.
void	setDistribution(Distribution distribution) The method used to distribute log data to the destination.
void	setDistribution(java.lang.String distribution) The method used to distribute log data to the destination.
void	setFilterName(java.lang.String filterName) A name for the subscription filter.
void	setFilterPattern(java.lang.String filterPattern) A filter pattern for subscribing to a filtered stream of log events.
void	setLogGroupName(java.lang.String logGroupName) The name of the log group.
void	setRoleArn(java.lang.String roleArn) The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
PutSubscriptionFilterRequest	withDestinationArn(java.lang.String destinationArn) The ARN of the destination to deliver matching log events to.
PutSubscriptionFilterRequest	withDistribution(Distribution distribution) The method used to distribute log data to the destination.
PutSubscriptionFilterRequest	withDistribution(java.lang.String distribution) The method used to distribute log data to the destination.
PutSubscriptionFilterRequest	withFilterName(java.lang.String filterName) A name for the subscription filter.
PutSubscriptionFilterRequest	withFilterPattern(java.lang.String filterPattern) A filter pattern for subscribing to a filtered stream of log events.
PutSubscriptionFilterRequest	withLogGroupName(java.lang.String logGroupName) The name of the log group.
PutSubscriptionFilterRequest	withRoleArn(java.lang.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 class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutSubscriptionFilterRequest

public PutSubscriptionFilterRequest()

Method Detail

getLogGroupName

public java.lang.String getLogGroupName()

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

The name of the log group.

setLogGroupName

public void setLogGroupName(java.lang.String logGroupName)

The name of the log group.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName -

The name of the log group.

withLogGroupName

public PutSubscriptionFilterRequest withLogGroupName(java.lang.String logGroupName)

The name of the log group.

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

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName -

The name of the log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilterName

public java.lang.String getFilterName()

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails 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.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

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

setFilterName

public void setFilterName(java.lang.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 fails 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.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

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

withFilterName

public PutSubscriptionFilterRequest withFilterName(java.lang.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 fails 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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

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 fails 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 reference to this updated object so that method calls can be chained together.

getFilterPattern

public java.lang.String getFilterPattern()

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

Constraints:
Length: 0 - 1024

Returns:

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

setFilterPattern

public void setFilterPattern(java.lang.String filterPattern)

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

Constraints:
Length: 0 - 1024

Parameters:

filterPattern -

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

withFilterPattern

public PutSubscriptionFilterRequest withFilterPattern(java.lang.String filterPattern)

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

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

Constraints:
Length: 0 - 1024

Parameters:

filterPattern -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getDestinationArn

public java.lang.String getDestinationArn()

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

Constraints:
Length: 1 -

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

setDestinationArn

public void setDestinationArn(java.lang.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 delivery 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.

Constraints:
Length: 1 -

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

withDestinationArn

public PutSubscriptionFilterRequest withDestinationArn(java.lang.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 delivery 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

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 delivery 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:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public java.lang.String getRoleArn()

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.

Constraints:
Length: 1 -

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.

setRoleArn

public void setRoleArn(java.lang.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.

Constraints:
Length: 1 -

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.

withRoleArn

public PutSubscriptionFilterRequest withRoleArn(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

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:

A reference to this updated object so that method calls can be chained together.

getDistribution

public java.lang.String getDistribution()

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.

Constraints:
Allowed Values: Random, ByLogStream

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

setDistribution

public void setDistribution(java.lang.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 stream.

Constraints:
Allowed Values: Random, ByLogStream

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

See Also:

Distribution

withDistribution

public PutSubscriptionFilterRequest withDistribution(java.lang.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 stream.

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

Constraints:
Allowed Values: Random, ByLogStream

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Distribution

setDistribution

public void setDistribution(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.

Constraints:
Allowed Values: Random, ByLogStream

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

See Also:

Distribution

withDistribution

public PutSubscriptionFilterRequest withDistribution(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.

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

Constraints:
Allowed Values: Random, ByLogStream

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Distribution

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object