software.amazon.awscdk.services.logs

Enum RetentionDays

java.lang.Object

java.lang.Enum<RetentionDays>

software.amazon.awscdk.services.logs.RetentionDays

All Implemented Interfaces:

Serializable, Comparable<RetentionDays>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:10.681Z")
 @Stability(value=Experimental)
public enum RetentionDays
extends Enum<RetentionDays>

(experimental) How long, in days, the log contents will be retained.

Example:

 import software.amazon.awscdk.core.*;
 Role myLogsPublishingRole;
 Vpc vpc;
 // Exporting logs from a cluster
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.aurora(AuroraClusterEngineProps.builder()
                 .version(AuroraEngineVersion.VER_1_17_9)
                 .build()))
         .instanceProps(InstanceProps.builder()
                 .vpc(vpc)
                 .build())
         .cloudwatchLogsExports(List.of("error", "general", "slowquery", "audit")) // Export all available MySQL-based logs
         .cloudwatchLogsRetention(RetentionDays.THREE_MONTHS) // Optional - default is to never expire logs
         .cloudwatchLogsRetentionRole(myLogsPublishingRole)
         .build();
 // Exporting logs from an instance
 DatabaseInstance instance = DatabaseInstance.Builder.create(this, "Instance")
         .engine(DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder()
                 .version(PostgresEngineVersion.VER_12_3)
                 .build()))
         .vpc(vpc)
         .cloudwatchLogsExports(List.of("postgresql"))
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
EIGHT_YEARS (experimental) 8 years.
EIGHTEEN_MONTHS (experimental) 18 months.
FIVE_DAYS (experimental) 5 days.
FIVE_MONTHS (experimental) 5 months.
FIVE_YEARS (experimental) 5 years.
FOUR_MONTHS (experimental) 4 months.
INFINITE (experimental) Retain logs forever.
NINE_YEARS (experimental) 9 years.
ONE_DAY (experimental) 1 day.
ONE_MONTH (experimental) 1 month.
ONE_WEEK (experimental) 1 week.
ONE_YEAR (experimental) 1 year.
SEVEN_YEARS (experimental) 7 years.
SIX_MONTHS (experimental) 6 months.
SIX_YEARS (experimental) 6 years.
TEN_YEARS (experimental) 10 years.
THIRTEEN_MONTHS (experimental) 13 months.
THREE_DAYS (experimental) 3 days.
THREE_MONTHS (experimental) 3 months.
TWO_MONTHS (experimental) 2 months.
TWO_WEEKS (experimental) 2 weeks.
TWO_YEARS (experimental) 2 years.

Method Summary

Modifier and Type	Method and Description
static RetentionDays	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetentionDays[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONE_DAY

@Stability(value=Experimental)
public static final RetentionDays ONE_DAY

(experimental) 1 day.

THREE_DAYS

@Stability(value=Experimental)
public static final RetentionDays THREE_DAYS

(experimental) 3 days.

FIVE_DAYS

@Stability(value=Experimental)
public static final RetentionDays FIVE_DAYS

(experimental) 5 days.

ONE_WEEK

@Stability(value=Experimental)
public static final RetentionDays ONE_WEEK

(experimental) 1 week.

TWO_WEEKS

@Stability(value=Experimental)
public static final RetentionDays TWO_WEEKS

(experimental) 2 weeks.

ONE_MONTH

@Stability(value=Experimental)
public static final RetentionDays ONE_MONTH

(experimental) 1 month.

TWO_MONTHS

@Stability(value=Experimental)
public static final RetentionDays TWO_MONTHS

(experimental) 2 months.

THREE_MONTHS

@Stability(value=Experimental)
public static final RetentionDays THREE_MONTHS

(experimental) 3 months.

FOUR_MONTHS

@Stability(value=Experimental)
public static final RetentionDays FOUR_MONTHS

(experimental) 4 months.

FIVE_MONTHS

@Stability(value=Experimental)
public static final RetentionDays FIVE_MONTHS

(experimental) 5 months.

SIX_MONTHS

@Stability(value=Experimental)
public static final RetentionDays SIX_MONTHS

(experimental) 6 months.

ONE_YEAR

@Stability(value=Experimental)
public static final RetentionDays ONE_YEAR

(experimental) 1 year.

THIRTEEN_MONTHS

@Stability(value=Experimental)
public static final RetentionDays THIRTEEN_MONTHS

(experimental) 13 months.

EIGHTEEN_MONTHS

@Stability(value=Experimental)
public static final RetentionDays EIGHTEEN_MONTHS

(experimental) 18 months.

TWO_YEARS

@Stability(value=Experimental)
public static final RetentionDays TWO_YEARS

(experimental) 2 years.

FIVE_YEARS

@Stability(value=Experimental)
public static final RetentionDays FIVE_YEARS

(experimental) 5 years.

SIX_YEARS

@Stability(value=Experimental)
public static final RetentionDays SIX_YEARS

(experimental) 6 years.

SEVEN_YEARS

@Stability(value=Experimental)
public static final RetentionDays SEVEN_YEARS

(experimental) 7 years.

EIGHT_YEARS

@Stability(value=Experimental)
public static final RetentionDays EIGHT_YEARS

(experimental) 8 years.

NINE_YEARS

@Stability(value=Experimental)
public static final RetentionDays NINE_YEARS

(experimental) 9 years.

TEN_YEARS

@Stability(value=Experimental)
public static final RetentionDays TEN_YEARS

(experimental) 10 years.

INFINITE

@Stability(value=Experimental)
public static final RetentionDays INFINITE

(experimental) Retain logs forever.

Method Detail

values

public static RetentionDays[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RetentionDays c : RetentionDays.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RetentionDays valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null