Package software.amazon.awscdk.services.logs

Class LogGroup.Builder

java.lang.Object
software.amazon.awscdk.services.logs.LogGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<LogGroup>
Enclosing class:
LogGroup
@Stability(Stable) public static final class LogGroup.Builder extends Object implements software.amazon.jsii.Builder<LogGroup>
A fluent builder for LogGroup.

  • Method Details

    • create

      @Stability(Stable) public static LogGroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of LogGroup.Builder.

    • encryptionKey

      @Stability(Stable) public LogGroup.Builder encryptionKey(IKey encryptionKey)
      The KMS Key to encrypt the log group with.

      Default: - log group is encrypted with the default master key

      Parameters:
      encryptionKey - The KMS Key to encrypt the log group with. This parameter is required.
      Returns:
      this

    • logGroupName

      @Stability(Stable) public LogGroup.Builder logGroupName(String logGroupName)
      Name of the log group.

      Default: Automatically generated

      Parameters:
      logGroupName - Name of the log group. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Stable) public LogGroup.Builder removalPolicy(RemovalPolicy removalPolicy)
      Determine the removal policy of this log group.

      Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs.

      Default: RemovalPolicy.Retain

      Parameters:
      removalPolicy - Determine the removal policy of this log group. This parameter is required.
      Returns:
      this

    • retention

      @Stability(Stable) public LogGroup.Builder retention(RetentionDays retention)
      How long, in days, the log contents will be retained.

      To retain all logs, set this value to RetentionDays.INFINITE.

      Default: RetentionDays.TWO_YEARS

      Parameters:
      retention - How long, in days, the log contents will be retained. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public LogGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<LogGroup>
      Returns:
      a newly built instance of LogGroup.