com.amazonaws.services.logs.model

Class PutSubscriptionFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutSubscriptionFilterRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutSubscriptionFilterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutSubscriptionFilter operation.

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 requests and have them delivered to a specific destination. Currently, the supported destinations are:

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination ) belonging to a different account, for cross-account delivery.

Currently there can only be one subscription filter associated with a log group.

See Also:

AWSLogs.putSubscriptionFilter(PutSubscriptionFilterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutSubscriptionFilterRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutSubscriptionFilterRequest	clone()
boolean	equals(Object obj)
String	getDestinationArn() The ARN of the destination to deliver matching log events to.
String	getFilterName() A name for the subscription filter.
String	getFilterPattern() A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
String	getLogGroupName() The name of the log group to associate the subscription filter with.
String	getRoleArn() The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream.
int	hashCode()
void	setDestinationArn(String destinationArn) The ARN of the destination to deliver matching log events to.
void	setFilterName(String filterName) A name for the subscription filter.
void	setFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
void	setLogGroupName(String logGroupName) The name of the log group to associate the subscription filter with.
void	setRoleArn(String roleArn) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutSubscriptionFilterRequest	withDestinationArn(String destinationArn) The ARN of the destination to deliver matching log events to.
PutSubscriptionFilterRequest	withFilterName(String filterName) A name for the subscription filter.
PutSubscriptionFilterRequest	withFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
PutSubscriptionFilterRequest	withLogGroupName(String logGroupName) The name of the log group to associate the subscription filter with.
PutSubscriptionFilterRequest	withRoleArn(String roleArn) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

PutSubscriptionFilterRequest

public PutSubscriptionFilterRequest()

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to associate the subscription filter with.

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

Returns:

The name of the log group to associate the subscription filter with.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to associate the subscription filter with.

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

Parameters:

logGroupName - The name of the log group to associate the subscription filter with.

withLogGroupName

public PutSubscriptionFilterRequest withLogGroupName(String logGroupName)

The name of the log group to associate the subscription filter with.

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 to associate the subscription filter with.

Returns:

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

getFilterName

public String getFilterName()

A name for the subscription filter.

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

Returns:

A name for the subscription filter.

setFilterName

public void setFilterName(String filterName)

A name for the subscription filter.

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

Parameters:

filterName - A name for the subscription filter.

withFilterName

public PutSubscriptionFilterRequest withFilterName(String filterName)

A name for the subscription filter.

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.

Returns:

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

getFilterPattern

public String getFilterPattern()

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

Constraints:
Length: 0 - 512

Returns:

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

setFilterPattern

public void setFilterPattern(String filterPattern)

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

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.

withFilterPattern

public PutSubscriptionFilterRequest withFilterPattern(String filterPattern)

A valid CloudWatch Logs 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 - 512

Parameters:

filterPattern - A valid CloudWatch Logs 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 String getDestinationArn()

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

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.

Constraints:
Length: 1 -

Returns:

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

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.

setDestinationArn

public void setDestinationArn(String destinationArn)

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

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.

Constraints:
Length: 1 -

Parameters:

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

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.

withDestinationArn

public PutSubscriptionFilterRequest withDestinationArn(String destinationArn)

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

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-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:

• A Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination (used via an ARN of Destination) belonging to a different account, for cross-account delivery.

Returns:

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

getRoleArn

public String getRoleArn()

The ARN of an IAM role that grants Amazon 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 (used via an ARN of Destination) for cross-account delivery.

Constraints:
Length: 1 -

Returns:

The ARN of an IAM role that grants Amazon 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 (used via an ARN of Destination) for cross-account delivery.

setRoleArn

public void setRoleArn(String roleArn)

The ARN of an IAM role that grants Amazon 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 (used via an ARN of Destination) for cross-account delivery.

Constraints:
Length: 1 -

Parameters:

roleArn - The ARN of an IAM role that grants Amazon 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 (used via an ARN of Destination) for cross-account delivery.

withRoleArn

public PutSubscriptionFilterRequest withRoleArn(String roleArn)

The ARN of an IAM role that grants Amazon 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 (used via an ARN of 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 Amazon 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 (used via an ARN of Destination) for cross-account delivery.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutSubscriptionFilterRequest clone()

Overrides:

clone in class AmazonWebServiceRequest