Package software.amazon.awscdk.services.imagebuilder

Interface CfnLifecyclePolicy.FilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.FilterProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.FilterProperty
extends software.amazon.jsii.JsiiSerializable

Defines filters that the lifecycle policy uses to determine impacted resource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 FilterProperty filterProperty = FilterProperty.builder()
         .type("type")
         .value(123)
         // the properties below are optional
         .retainAtLeast(123)
         .unit("unit")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecyclePolicy.FilterProperty.Builder	A builder for CfnLifecyclePolicy.FilterProperty
static final class	CfnLifecyclePolicy.FilterProperty.Jsii$Proxy	An implementation for CfnLifecyclePolicy.FilterProperty

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.FilterProperty.Builder	builder()
default Number	getRetainAtLeast()	For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied.
String	getType()	Filter resources based on either age or count .
default String	getUnit()	Defines the unit of time that the lifecycle policy uses to determine impacted resources.
Number	getValue()	The number of units for the time period or for the count.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

Filter resources based on either age or count .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-type

getValue

@Stability(Stable)
@NotNull
Number getValue()

The number of units for the time period or for the count.

For example, a value of 6 might refer to six months or six AMIs.

For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-value

getRetainAtLeast

@Stability(Stable)
@Nullable
default Number getRetainAtLeast()

For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied.

Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-retainatleast

getUnit

@Stability(Stable)
@Nullable
default String getUnit()

Defines the unit of time that the lifecycle policy uses to determine impacted resources.

This is required for age-based rules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-lifecyclepolicy-filter.html#cfn-imagebuilder-lifecyclepolicy-filter-unit

builder

@Stability(Stable)
static CfnLifecyclePolicy.FilterProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.FilterProperty.Builder of CfnLifecyclePolicy.FilterProperty