com.amazonaws.services.logs.model

Class PutSubscriptionFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutSubscriptionFilterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutSubscriptionFilterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutSubscriptionFilterRequest()

Method Summary

Modifier and Type	Method and Description
PutSubscriptionFilterRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDestinationArn() The ARN of the destination to deliver matching log events to.
String	getDistribution() The method used to distribute log data to the destination.
String	getFilterName() A name for the subscription filter.
String	getFilterPattern() A filter pattern for subscribing to a filtered stream of log events.
String	getLogGroupName() The name of the log group.
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(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(String distribution) The method used to distribute log data to the destination.
void	setFilterName(String filterName) A name for the subscription filter.
void	setFilterPattern(String filterPattern) A filter pattern for subscribing to a filtered stream of log events.
void	setLogGroupName(String logGroupName) The name of the log group.
void	setRoleArn(String roleArn) The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.
String	toString() Returns a string representation of this object.
PutSubscriptionFilterRequest	withDestinationArn(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(String distribution) The method used to distribute log data to the destination.
PutSubscriptionFilterRequest	withFilterName(String filterName) A name for the subscription filter.
PutSubscriptionFilterRequest	withFilterPattern(String filterPattern) A filter pattern for subscribing to a filtered stream of log events.
PutSubscriptionFilterRequest	withLogGroupName(String logGroupName) The name of the log group.
PutSubscriptionFilterRequest	withRoleArn(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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutSubscriptionFilterRequest

public PutSubscriptionFilterRequest()

Method Detail

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group.

Parameters:

logGroupName - The name of the log group.

getLogGroupName

public String getLogGroupName()

The name of the log group.

Returns:

The name of the log group.

withLogGroupName

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

setFilterName

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

Parameters:

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.

getFilterName

public String getFilterName()

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.

withFilterName

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

Parameters:

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:

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

setFilterPattern

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

getFilterPattern

public String getFilterPattern()

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.

withFilterPattern

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

setDestinationArn

public void setDestinationArn(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're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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.

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.

  If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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.

getDestinationArn

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

  If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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.

withDestinationArn

public PutSubscriptionFilterRequest withDestinationArn(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're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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.

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.

  If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

• A Kinesis Data 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:

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

setRoleArn

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

getRoleArn

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

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.

withRoleArn

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

setDistribution

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

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

See Also:

Distribution

getDistribution

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

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

See Also:

Distribution

withDistribution

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

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

Returns:

Returns a reference to this 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 data stream.

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

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

Returns:

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

See Also:

Distribution

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutSubscriptionFilterRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()