Package software.amazon.awscdk.services.logs

Class CfnSubscriptionFilter.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnSubscriptionFilter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSubscriptionFilter>

Enclosing class:

CfnSubscriptionFilter

@Stability(Stable)
public static final class CfnSubscriptionFilter.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSubscriptionFilter>

A fluent builder for CfnSubscriptionFilter.

Method Summary

Modifier and Type	Method	Description
CfnSubscriptionFilter.Builder	applyOnTransformedLogs(Boolean applyOnTransformedLogs)	This parameter is valid only for log groups that have an active log transformer.
CfnSubscriptionFilter.Builder	applyOnTransformedLogs(IResolvable applyOnTransformedLogs)	This parameter is valid only for log groups that have an active log transformer.
CfnSubscriptionFilter	build()
static CfnSubscriptionFilter.Builder	create(software.constructs.Construct scope, String id)
CfnSubscriptionFilter.Builder	destinationArn(String destinationArn)	The Amazon Resource Name (ARN) of the destination.
CfnSubscriptionFilter.Builder	distribution(String distribution)	The method used to distribute log data to the destination, which can be either random or grouped by log stream.
CfnSubscriptionFilter.Builder	filterName(String filterName)	The name of the subscription filter.
CfnSubscriptionFilter.Builder	filterPattern(String filterPattern)	The filtering expressions that restrict what gets delivered to the destination AWS resource.
CfnSubscriptionFilter.Builder	logGroupName(String logGroupName)	The log group to associate with the subscription filter.
CfnSubscriptionFilter.Builder	roleArn(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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnSubscriptionFilter.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSubscriptionFilter.Builder.

destinationArn

@Stability(Stable)
public CfnSubscriptionFilter.Builder destinationArn(String destinationArn)

The Amazon Resource Name (ARN) of the destination.

Parameters:

destinationArn - The Amazon Resource Name (ARN) of the destination. This parameter is required.

Returns:

this

See Also:

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

filterPattern

@Stability(Stable)
public CfnSubscriptionFilter.Builder filterPattern(String filterPattern)

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 .

Parameters:

filterPattern - The filtering expressions that restrict what gets delivered to the destination AWS resource. This parameter is required.

Returns:

this

See Also:

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

logGroupName

@Stability(Stable)
public CfnSubscriptionFilter.Builder logGroupName(String logGroupName)

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.

Parameters:

logGroupName - The log group to associate with the subscription filter. This parameter is required.

Returns:

this

See Also:

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

applyOnTransformedLogs

@Stability(Stable)
public CfnSubscriptionFilter.Builder applyOnTransformedLogs(Boolean applyOnTransformedLogs)

This parameter is valid only for log groups that have an active log transformer.

For more information about log transformers, see PutTransformer .

If this value is true , the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

Parameters:

applyOnTransformedLogs - This parameter is valid only for log groups that have an active log transformer. This parameter is required.

Returns:

this

See Also:

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

applyOnTransformedLogs

@Stability(Stable)
public CfnSubscriptionFilter.Builder applyOnTransformedLogs(IResolvable applyOnTransformedLogs)

This parameter is valid only for log groups that have an active log transformer.

For more information about log transformers, see PutTransformer .

If this value is true , the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

Parameters:

applyOnTransformedLogs - This parameter is valid only for log groups that have an active log transformer. This parameter is required.

Returns:

this

See Also:

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

distribution

@Stability(Stable)
public CfnSubscriptionFilter.Builder distribution(String distribution)

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

Parameters:

distribution - The method used to distribute log data to the destination, which can be either random or grouped by log stream. This parameter is required.

Returns:

this

See Also:

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

filterName

@Stability(Stable)
public CfnSubscriptionFilter.Builder filterName(String filterName)

The name of the subscription filter.

Parameters:

filterName - The name of the subscription filter. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnSubscriptionFilter.Builder roleArn(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. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSubscriptionFilter build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSubscriptionFilter>

Returns:

a newly built instance of CfnSubscriptionFilter.