Package software.amazon.awscdk.cfnpropertymixins.services.rbin

Interface CfnRulePropsMixin.RetentionPeriodProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRulePropsMixin.RetentionPeriodProperty.Jsii$Proxy

Enclosing class:

CfnRulePropsMixin

@Stability(Stable)
public static interface CfnRulePropsMixin.RetentionPeriodProperty
extends software.amazon.jsii.JsiiSerializable

Information about the retention period for which the retention rule is to retain resources.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.rbin.*;
 RetentionPeriodProperty retentionPeriodProperty = RetentionPeriodProperty.builder()
         .retentionPeriodUnit("retentionPeriodUnit")
         .retentionPeriodValue(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRulePropsMixin.RetentionPeriodProperty.Builder	builder()
default String	getRetentionPeriodUnit()	The unit of time in which the retention period is measured.
default Number	getRetentionPeriodValue()	The period value for which the retention rule is to retain resources, measured in days.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRetentionPeriodUnit

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

The unit of time in which the retention period is measured.

Currently, only DAYS is supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodunit

getRetentionPeriodValue

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

The period value for which the retention rule is to retain resources, measured in days.

The supported retention periods are:

• EBS volumes: 1 - 7 days
• EBS snapshots and EBS-backed AMIs: 1 - 365 days

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodvalue

builder

@Stability(Stable)
static CfnRulePropsMixin.RetentionPeriodProperty.Builder builder()

Returns:

a CfnRulePropsMixin.RetentionPeriodProperty.Builder of CfnRulePropsMixin.RetentionPeriodProperty