@Generated(value="software.amazon.awssdk:codegen") public class PutSubscriptionFilterRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutSubscriptionFilterRequest.Builder |
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 |
distributionString()
The method used to distribute log data to the destination.
|
boolean |
equals(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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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.
|
static Class<? extends PutSubscriptionFilterRequest.Builder> |
serializableBuilderClass() |
PutSubscriptionFilterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String logGroupName()
The name of the log group.
public 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.
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.public String filterPattern()
A filter pattern for subscribing to a filtered stream of log events.
public 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.
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.
public 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.
public 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
distributionString()
.
Distribution
public String distributionString()
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
distributionString()
.
Distribution
public PutSubscriptionFilterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutSubscriptionFilterRequest.Builder,PutSubscriptionFilterRequest>
toBuilder
in class CloudWatchLogsRequest
public static PutSubscriptionFilterRequest.Builder builder()
public static Class<? extends PutSubscriptionFilterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.