software.amazon.awscdk.services.logs

Class LogStreamProps.Builder

java.lang.Object

software.amazon.awscdk.services.logs.LogStreamProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LogStreamProps>

Enclosing interface:

LogStreamProps

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

A builder for LogStreamProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LogStreamProps	build() Builds the configured instance.
LogStreamProps.Builder	logGroup(ILogGroup logGroup) Sets the value of LogStreamProps.getLogGroup()
LogStreamProps.Builder	logStreamName(String logStreamName) Sets the value of LogStreamProps.getLogStreamName()
LogStreamProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of LogStreamProps.getRemovalPolicy()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

logGroup

@Stability(value=Stable)
public LogStreamProps.Builder logGroup(ILogGroup logGroup)

Sets the value of LogStreamProps.getLogGroup()

Parameters:

logGroup - The log group to create a log stream for. This parameter is required.

Returns:

this

logStreamName

@Stability(value=Stable)
public LogStreamProps.Builder logStreamName(String logStreamName)

Sets the value of LogStreamProps.getLogStreamName()

Parameters:

logStreamName - The name of the log stream to create. The name must be unique within the log group.

Returns:

this

removalPolicy

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

Sets the value of LogStreamProps.getRemovalPolicy()

Parameters:

removalPolicy - Determine what happens when the log stream resource is removed from the app. Normally you want to retain the log stream so you can diagnose issues from logs even after a deployment that no longer includes the log stream.

The date-based retention policy of your log group will age out the logs after a certain time.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LogStreamProps

Throws:

NullPointerException - if any required attribute was not provided