Package software.amazon.awscdk.services.rbin

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:14.604Z")
@Stability(Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRule.

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.rbin.*;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .resourceType("resourceType")
         .retentionPeriod(RetentionPeriodProperty.builder()
                 .retentionPeriodUnit("retentionPeriodUnit")
                 .retentionPeriodValue(123)
                 .build())
         // the properties below are optional
         .description("description")
         .excludeResourceTags(List.of(ResourceTagProperty.builder()
                 .resourceTagKey("resourceTagKey")
                 .resourceTagValue("resourceTagValue")
                 .build()))
         .lockConfiguration(UnlockDelayProperty.builder()
                 .unlockDelayUnit("unlockDelayUnit")
                 .unlockDelayValue(123)
                 .build())
         .resourceTags(List.of(ResourceTagProperty.builder()
                 .resourceTagKey("resourceTagKey")
                 .resourceTagValue("resourceTagValue")
                 .build()))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleProps.Builder	builder()
default String	getDescription()	The description of the retention rule.
default Object	getExcludeResourceTags()	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
default Object	getLockConfiguration()
default Object	getResourceTags()	Information about the resource tags used to identify resources that are retained by the retention rule.
String	getResourceType()	The resource type retained by the retention rule.
Object	getRetentionPeriod()	The retention period of the rule.
default String	getStatus()	The state of the retention rule.
default List<CfnTag>	getTags()	Information about the tags assigned to the retention rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceType

@Stability(Stable)
@NotNull
String getResourceType()

The resource type retained by the retention rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetype

getRetentionPeriod

@Stability(Stable)
@NotNull
Object getRetentionPeriod()

The retention period of the rule.

See Also:

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

getDescription

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

The description of the retention rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-description

getExcludeResourceTags

@Stability(Stable)
@Nullable
default Object getExcludeResourceTags()

Information about the exclude resource tags used to identify resources that are excluded by the retention rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-excluderesourcetags

getLockConfiguration

@Stability(Stable)
@Nullable
default Object getLockConfiguration()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-lockconfiguration

getResourceTags

@Stability(Stable)
@Nullable
default Object getResourceTags()

Information about the resource tags used to identify resources that are retained by the retention rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetags

getStatus

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

The state of the retention rule.

Only retention rules that are in the available state retain resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Information about the tags assigned to the retention rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-tags

builder

@Stability(Stable)
static CfnRuleProps.Builder builder()

Returns:

a CfnRuleProps.Builder of CfnRuleProps