software.amazon.awscdk.services.events.targets

Class CloudWatchLogGroup.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.CloudWatchLogGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudWatchLogGroup>

Enclosing class:

CloudWatchLogGroup

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

A fluent builder for CloudWatchLogGroup.

Method Summary

Modifier and Type	Method and Description
CloudWatchLogGroup	build()
static CloudWatchLogGroup.Builder	create(ILogGroup logGroup)
CloudWatchLogGroup.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
CloudWatchLogGroup.Builder	event(RuleTargetInput event) Deprecated. use logEvent instead
CloudWatchLogGroup.Builder	logEvent(LogGroupTargetInput logEvent) The event to send to the CloudWatch LogGroup.
CloudWatchLogGroup.Builder	maxEventAge(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.
CloudWatchLogGroup.Builder	retryAttempts(Number retryAttempts) The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CloudWatchLogGroup.Builder create(ILogGroup logGroup)

Parameters:

logGroup - This parameter is required.

Returns:

a new instance of CloudWatchLogGroup.Builder.

deadLetterQueue

@Stability(value=Stable)
public CloudWatchLogGroup.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

maxEventAge

@Stability(value=Stable)
public CloudWatchLogGroup.Builder maxEventAge(Duration maxEventAge)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(value=Stable)
public CloudWatchLogGroup.Builder retryAttempts(Number retryAttempts)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

event

@Stability(value=Deprecated)
 @Deprecated
public CloudWatchLogGroup.Builder event(RuleTargetInput event)

Deprecated. use logEvent instead

(deprecated) The event to send to the CloudWatch LogGroup.

This will be the event logged into the CloudWatch LogGroup

Default: - the entire EventBridge event

Parameters:

event - The event to send to the CloudWatch LogGroup. This parameter is required.

Returns:

this

logEvent

@Stability(value=Stable)
public CloudWatchLogGroup.Builder logEvent(LogGroupTargetInput logEvent)

The event to send to the CloudWatch LogGroup.

This will be the event logged into the CloudWatch LogGroup

Default: - the entire EventBridge event

Parameters:

logEvent - The event to send to the CloudWatch LogGroup. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CloudWatchLogGroup build()

Specified by:

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