public class PutSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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:
Destination ) belonging to a different account, for
cross-account delivery. Currently there can only be one subscription filter associated with a log group.
NOOP| Constructor and Description |
|---|
PutSubscriptionFilterRequest() |
| 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.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic String getLogGroupName()
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
public void setLogGroupName(String logGroupName)
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
logGroupName - The name of the log group to associate the subscription filter with.public PutSubscriptionFilterRequest withLogGroupName(String logGroupName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
logGroupName - The name of the log group to associate the subscription filter with.public String getFilterName()
Constraints:
Length: 1 - 512
Pattern: [^:*]*
public void setFilterName(String filterName)
Constraints:
Length: 1 - 512
Pattern: [^:*]*
filterName - A name for the subscription filter.public PutSubscriptionFilterRequest withFilterName(String filterName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 512
Pattern: [^:*]*
filterName - A name for the subscription filter.public String getFilterPattern()
Constraints:
Length: 0 - 512
public void setFilterPattern(String filterPattern)
Constraints:
Length: 0 - 512
filterPattern - A valid CloudWatch Logs filter pattern for subscribing to a filtered
stream of log events.public PutSubscriptionFilterRequest withFilterPattern(String filterPattern)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 512
filterPattern - A valid CloudWatch Logs filter pattern for subscribing to a filtered
stream of log events.public String getDestinationArn()
Destination) belonging to a different account, for
cross-account delivery.
Constraints:
Length: 1 -
Destination) belonging to a different account, for
cross-account delivery. public void setDestinationArn(String destinationArn)
Destination) belonging to a different account, for
cross-account delivery.
Constraints:
Length: 1 -
destinationArn - The ARN of the destination to deliver matching log events to.
Currently, the supported destinations are: Destination) belonging to a different account, for
cross-account delivery. public PutSubscriptionFilterRequest withDestinationArn(String destinationArn)
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 -
destinationArn - The ARN of the destination to deliver matching log events to.
Currently, the supported destinations are: Destination) belonging to a different account, for
cross-account delivery. public String getRoleArn()
Destination) for
cross-account delivery.
Constraints:
Length: 1 -
Destination) for
cross-account delivery.public void setRoleArn(String roleArn)
Destination) for
cross-account delivery.
Constraints:
Length: 1 -
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.public PutSubscriptionFilterRequest withRoleArn(String roleArn)
Destination) for
cross-account delivery.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
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.public String toString()
toString in class ObjectObject.toString()public PutSubscriptionFilterRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2015. All rights reserved.