Package software.amazon.awscdk.services.logs

Interface CfnSubscriptionFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriptionFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:19.321Z")
@Stability(Stable)
public interface CfnSubscriptionFilterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubscriptionFilter.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnSubscriptionFilterProps cfnSubscriptionFilterProps = CfnSubscriptionFilterProps.builder()
         .destinationArn("destinationArn")
         .filterPattern("filterPattern")
         .logGroupName("logGroupName")
         // the properties below are optional
         .distribution("distribution")
         .filterName("filterName")
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubscriptionFilterProps.Builder	A builder for CfnSubscriptionFilterProps
static final class	CfnSubscriptionFilterProps.Jsii$Proxy	An implementation for CfnSubscriptionFilterProps

Method Summary

Modifier and Type	Method	Description
static CfnSubscriptionFilterProps.Builder	builder()
String	getDestinationArn()	The Amazon Resource Name (ARN) of the destination.
default String	getDistribution()	The method used to distribute log data to the destination, which can be either random or grouped by log stream.
default String	getFilterName()	The name of the subscription filter.
String	getFilterPattern()	The filtering expressions that restrict what gets delivered to the destination AWS resource.
String	getLogGroupName()	The log group to associate with the subscription filter.
default String	getRoleArn()	The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationArn

@Stability(Stable)
@NotNull
String getDestinationArn()

The Amazon Resource Name (ARN) of the destination.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn

getFilterPattern

@Stability(Stable)
@NotNull
String getFilterPattern()

The filtering expressions that restrict what gets delivered to the destination AWS resource.

For more information about the filter pattern syntax, see Filter and Pattern Syntax .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern

getLogGroupName

@Stability(Stable)
@NotNull
String getLogGroupName()

The log group to associate with the subscription filter.

All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname

getDistribution

@Stability(Stable)
@Nullable
default String getDistribution()

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution

getFilterName

@Stability(Stable)
@Nullable
default String getFilterName()

The name of the subscription filter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername

getRoleArn

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn

builder

@Stability(Stable)
static CfnSubscriptionFilterProps.Builder builder()

Returns:

a CfnSubscriptionFilterProps.Builder of CfnSubscriptionFilterProps