Package software.amazon.awscdk.services.logs

Class CfnSubscriptionFilterProps.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnSubscriptionFilterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSubscriptionFilterProps>

Enclosing interface:

CfnSubscriptionFilterProps

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

A builder for CfnSubscriptionFilterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSubscriptionFilterProps.Builder	applyOnTransformedLogs(Boolean applyOnTransformedLogs)	Sets the value of CfnSubscriptionFilterProps.getApplyOnTransformedLogs()
CfnSubscriptionFilterProps.Builder	applyOnTransformedLogs(IResolvable applyOnTransformedLogs)	Sets the value of CfnSubscriptionFilterProps.getApplyOnTransformedLogs()
CfnSubscriptionFilterProps	build()	Builds the configured instance.
CfnSubscriptionFilterProps.Builder	destinationArn(String destinationArn)	Sets the value of CfnSubscriptionFilterProps.getDestinationArn()
CfnSubscriptionFilterProps.Builder	distribution(String distribution)	Sets the value of CfnSubscriptionFilterProps.getDistribution()
CfnSubscriptionFilterProps.Builder	filterName(String filterName)	Sets the value of CfnSubscriptionFilterProps.getFilterName()
CfnSubscriptionFilterProps.Builder	filterPattern(String filterPattern)	Sets the value of CfnSubscriptionFilterProps.getFilterPattern()
CfnSubscriptionFilterProps.Builder	logGroupName(String logGroupName)	Sets the value of CfnSubscriptionFilterProps.getLogGroupName()
CfnSubscriptionFilterProps.Builder	roleArn(String roleArn)	Sets the value of CfnSubscriptionFilterProps.getRoleArn()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

destinationArn

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

Sets the value of CfnSubscriptionFilterProps.getDestinationArn()

Parameters:

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

Returns:

this

filterPattern

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

Sets the value of CfnSubscriptionFilterProps.getFilterPattern()

Parameters:

filterPattern - The filtering expressions that restrict what gets delivered to the destination AWS resource. This parameter is required. For more information about the filter pattern syntax, see Filter and Pattern Syntax .

Returns:

this

logGroupName

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

Sets the value of CfnSubscriptionFilterProps.getLogGroupName()

Parameters:

logGroupName - The log group to associate with the subscription filter. This parameter is required. 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.

Returns:

this

applyOnTransformedLogs

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

Sets the value of CfnSubscriptionFilterProps.getApplyOnTransformedLogs()

Parameters:

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.

Returns:

this

applyOnTransformedLogs

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

Sets the value of CfnSubscriptionFilterProps.getApplyOnTransformedLogs()

Parameters:

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.

Returns:

this

distribution

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

Sets the value of CfnSubscriptionFilterProps.getDistribution()

Parameters:

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

Returns:

this

filterName

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

Sets the value of CfnSubscriptionFilterProps.getFilterName()

Parameters:

filterName - The name of the subscription filter.

Returns:

this

roleArn

@Stability(Stable)
public CfnSubscriptionFilterProps.Builder roleArn(String roleArn)

Sets the value of CfnSubscriptionFilterProps.getRoleArn()

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:

this

build

@Stability(Stable)
public CfnSubscriptionFilterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnSubscriptionFilterProps

Throws:

NullPointerException - if any required attribute was not provided