ResourceCleanerProps

Properties for defining a ResourceCleaner.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ros-resourcecleaner

Initializer

import com.aliyun.ros.cdk.ros.ResourceCleanerProps;
ResourceCleanerProps.builder()
    .action(java.lang.String)
    .action(IResolvable)
//  .cleanUpAlgorithm(java.lang.String)
//  .cleanUpAlgorithm(IResolvable)
//  .cleanUpRetryCount(java.lang.Number)
//  .cleanUpRetryCount(IResolvable)
//  .cleanUpTimeout(java.lang.Number)
//  .cleanUpTimeout(IResolvable)
//  .disabledSideEffects(IResolvable)
//  .disabledSideEffects(java.util.List<java.lang.String)
//  .disabledSideEffects(IResolvable>)
//  .excludedResources(IResolvable)
//  .excludedResources(java.util.List<IResolvable)
//  .excludedResources(ExcludedResourcesProperty>)
//  .failureOption(java.lang.String)
//  .failureOption(IResolvable)
//  .mode(java.lang.String)
//  .mode(IResolvable)
//  .resourceFilters(IResolvable)
//  .resourceFilters(java.util.List<IResolvable)
//  .resourceFilters(ResourceFiltersProperty>)
//  .resources(IResolvable)
//  .resources(java.util.List<IResolvable)
//  .resources(ResourcesProperty>)
//  .resourceTypeOrder(IResolvable)
//  .resourceTypeOrder(java.util.List<java.lang.String)
//  .resourceTypeOrder(IResolvable>)
    .build();

Properties

Name	Type	Description
action	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property action: Resource cleaner actions: - Scan: Scanning phase.
cleanUpAlgorithm	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property cleanUpAlgorithm: The cleanup algorithm of cleanup phase: - ResourceDependency: Clean up by resource dependency tree.
cleanUpRetryCount	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property cleanUpRetryCount: The maximum number of executions of cleanup phase.
cleanUpTimeout	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property cleanUpTimeout: The timeout seconds of executions of cleanup phase.
disabledSideEffects	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property disabledSideEffects: Side effects to be disabled.
excludedResources	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListExcludedResourcesProperty>	Property excludedResources: Exclude parts from resources to be cleaned up.
failureOption	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property failureOption: The failure option of cleanup phase: - Normal: Resource failure does not affect the resources that depend on it.
mode	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property mode: The result mode of resource cleaner: - Strict: Any scanning or cleanup failure leads to the failure of the cleaner.
resourceFilters	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourceFiltersProperty>	Property resourceFilters: Resource filters that ResourceCleaner uses to filter out the resources to be cleaned up during scanning.
resources	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourcesProperty>	Property resources: Resources to be cleaned up.
resourceTypeOrder	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property resourceTypeOrder: This property takes effect only when property CleanUpAlgorithm is ResourceTypeOrder.

---

action^Required

public java.lang.Object getAction();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property action: Resource cleaner actions: - Scan: Scanning phase.

Scan out the resources to be cleaned up.

• CleanUp: Cleanup phase. Clean up the scanned resources. It it not allowed for resource creation.
• Scan+CleanUp: Scan first, then CleanUp.
• ScanWhenCreatingAndUpdating+CleanUpWhenDeleting: Scan when creating or updating resource, and CleanUp when deleting stack.

---

cleanUpAlgorithm^Optional

public java.lang.Object getCleanUpAlgorithm();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cleanUpAlgorithm: The cleanup algorithm of cleanup phase: - ResourceDependency: Clean up by resource dependency tree.

• ResourceTypeOrder: Clean up by resource type order. Property ResourceTypeOrder can be used to specify resource type order. If it is not specified, a default order will be used. Default to ResourceDependency.

---

cleanUpRetryCount^Optional

public java.lang.Object getCleanUpRetryCount();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property cleanUpRetryCount: The maximum number of executions of cleanup phase.

Default to 1, which means no retry. Conditions that trigger a retry: (the relationship is or) 1.There are resources which fail to be cleaned up. 2.The cleanup is timeout.

---

cleanUpTimeout^Optional

public java.lang.Object getCleanUpTimeout();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property cleanUpTimeout: The timeout seconds of executions of cleanup phase.

Default to 1 hour.

---

disabledSideEffects^Optional

public java.lang.Object getDisabledSideEffects();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property disabledSideEffects: Side effects to be disabled.

Cleaning up some resources will cause some side effects. If is not expected, use the property to disable them. The side effects can be found in response(ResourceCleaner) of API GetFeatureDetails.

---

excludedResources^Optional

public java.lang.Object getExcludedResources();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListExcludedResourcesProperty>

Property excludedResources: Exclude parts from resources to be cleaned up.

---

failureOption^Optional

public java.lang.Object getFailureOption();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property failureOption: The failure option of cleanup phase: - Normal: Resource failure does not affect the resources that depend on it.

• Fast: Resource failure causes all resources that depend on it to fail. Default to Normal.

---

mode^Optional

public java.lang.Object getMode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mode: The result mode of resource cleaner: - Strict: Any scanning or cleanup failure leads to the failure of the cleaner.

• Loose: Only a little scanning and cleanup failures lead to the failure of the cleaner. Most scanning failures will be ignored, failure messages can be found in ScanErrors or ResourceDetails. Most cleanup failures will be ignored, failure messages can be found in ResourceDetails. Default to Loose.

---

resourceFilters^Optional

public java.lang.Object getResourceFilters();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourceFiltersProperty>

Property resourceFilters: Resource filters that ResourceCleaner uses to filter out the resources to be cleaned up during scanning.

Only one of ResourceFilters and Resources can be specified. There are two filtering behaviors(Effect): Allow and Deny. The filters work as below: 1.Any resource denied by any Deny filter will not be cleaned up. 2.Only resources allowed by some Allow filter and not denied by any Deny filter will be cleaned up. If filters are changed during resource update, ResourceCleaner requires to rescan. And if Action equals CleanUp, an error occurs.

---

resources^Optional

public java.lang.Object getResources();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListResourcesProperty>

Property resources: Resources to be cleaned up.

Only one of Resources and ResourceFilters can be specified.

---

resourceTypeOrder^Optional

public java.lang.Object getResourceTypeOrder();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property resourceTypeOrder: This property takes effect only when property CleanUpAlgorithm is ResourceTypeOrder.

If it takes effect:

• Resources will be cleaned up in order from front to back.
• Resource with resource type not specified in this property will not be cleaned up.

---