software.amazon.awscdk.services.logs

Class LogRetention.Builder

java.lang.Object

software.amazon.awscdk.services.logs.LogRetention.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LogRetention>

Enclosing class:

LogRetention

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

A fluent builder for LogRetention.

Method Summary

Modifier and Type	Method and Description
LogRetention	build()
static LogRetention.Builder	create(software.constructs.Construct scope, String id)
LogRetention.Builder	logGroupName(String logGroupName) The log group name.
LogRetention.Builder	logGroupRegion(String logGroupRegion) The region where the log group should be created.
LogRetention.Builder	logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions) Retry options for all AWS API calls.
LogRetention.Builder	removalPolicy(RemovalPolicy removalPolicy) The removalPolicy for the log group when the stack is deleted.
LogRetention.Builder	retention(RetentionDays retention) The number of days log events are kept in CloudWatch Logs.
LogRetention.Builder	role(IRole role) The IAM role for the Lambda function associated with the custom resource.

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 LogRetention.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of LogRetention.Builder.

logGroupName

@Stability(value=Stable)
public LogRetention.Builder logGroupName(String logGroupName)

The log group name.

Parameters:

logGroupName - The log group name. This parameter is required.

Returns:

this

retention

@Stability(value=Stable)
public LogRetention.Builder retention(RetentionDays retention)

The number of days log events are kept in CloudWatch Logs.

Parameters:

retention - The number of days log events are kept in CloudWatch Logs. This parameter is required.

Returns:

this

logGroupRegion

@Stability(value=Stable)
public LogRetention.Builder logGroupRegion(String logGroupRegion)

The region where the log group should be created.

Default: - same region as the stack

Parameters:

logGroupRegion - The region where the log group should be created. This parameter is required.

Returns:

this

logRetentionRetryOptions

@Stability(value=Stable)
public LogRetention.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)

Retry options for all AWS API calls.

Default: - AWS SDK default retry options

Parameters:

logRetentionRetryOptions - Retry options for all AWS API calls. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Stable)
public LogRetention.Builder removalPolicy(RemovalPolicy removalPolicy)

The removalPolicy for the log group when the stack is deleted.

Default: RemovalPolicy.RETAIN

Parameters:

removalPolicy - The removalPolicy for the log group when the stack is deleted. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public LogRetention.Builder role(IRole role)

The IAM role for the Lambda function associated with the custom resource.

Default: - A new role is created

Parameters:

role - The IAM role for the Lambda function associated with the custom resource. This parameter is required.

Returns:

this

build

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

Specified by:

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