Package software.amazon.awscdk.services.synthetics

Enum Cleanup

java.lang.Object

java.lang.Enum<Cleanup>

software.amazon.awscdk.services.synthetics.Cleanup

All Implemented Interfaces:

Serializable, Comparable<Cleanup>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.696Z")
@Stability(Stable)
public enum Cleanup
extends Enum<Cleanup>

Different ways to clean up underlying Canary resources when the Canary is deleted.

Example:

 Canary canary = Canary.Builder.create(this, "Canary")
         .test(Test.custom(CustomTestOptions.builder()
                 .handler("index.handler")
                 .code(Code.fromInline("/* Synthetics handler code"))
                 .build()))
         .cleanup(Cleanup.LAMBDA)
         .runtime(Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LAMBDA	Clean up the underlying Lambda function only.
NOTHING	Clean up nothing.

Method Summary

Modifier and Type	Method	Description
static Cleanup	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Cleanup[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOTHING

@Stability(Stable)
public static final Cleanup NOTHING

Clean up nothing.

The user is responsible for cleaning up all resources left behind by the Canary.

LAMBDA

@Stability(Stable)
public static final Cleanup LAMBDA

Clean up the underlying Lambda function only.

The user is responsible for cleaning up all other resources left behind by the Canary.

Method Details

values

public static Cleanup[] values()

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

Returns:

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

valueOf

public static Cleanup 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