Package software.amazon.awscdk.services.rbin

Class CfnRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.rbin.CfnRule

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:14.601Z")
@Stability(Stable)
public class CfnRule
extends CfnResource
implements IInspectable, ITaggableV2

Resource Type definition for AWS::Rbin::Rule.

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.*;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .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	Class	Description
static final class	CfnRule.Builder	A fluent builder for CfnRule.
static interface	CfnRule.ResourceTagProperty	The resource tag of the rule.
static interface	CfnRule.RetentionPeriodProperty	The retention period of the rule.
static interface	CfnRule.UnlockDelayProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRule(software.constructs.Construct scope, String id, CfnRuleProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	Rule Arn is unique for each rule.
String	getAttrIdentifier()	The unique ID of the retention rule.
String	getAttrLockState()	The lock state for the retention rule.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the retention rule.
Object	getExcludeResourceTags()	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
Object	getLockConfiguration()
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.
String	getStatus()	The state of the retention rule.
List<CfnTag>	getTags()	Information about the tags assigned to the retention rule.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the retention rule.
void	setExcludeResourceTags(List<Object> value)	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
void	setExcludeResourceTags(IResolvable value)	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
void	setLockConfiguration(IResolvable value)
void	setLockConfiguration(CfnRule.UnlockDelayProperty value)
void	setResourceTags(List<Object> value)	Information about the resource tags used to identify resources that are retained by the retention rule.
void	setResourceTags(IResolvable value)	Information about the resource tags used to identify resources that are retained by the retention rule.
void	setResourceType(String value)	The resource type retained by the retention rule.
void	setRetentionPeriod(IResolvable value)	The retention period of the rule.
void	setRetentionPeriod(CfnRule.RetentionPeriodProperty value)	The retention period of the rule.
void	setStatus(String value)	The state of the retention rule.
void	setTags(List<CfnTag> value)	Information about the tags assigned to the retention rule.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnRule

protected CfnRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnRule

protected CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRule

@Stability(Stable)
public CfnRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRuleProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

Rule Arn is unique for each rule.

getAttrIdentifier

@Stability(Stable)
@NotNull
public String getAttrIdentifier()

The unique ID of the retention rule.

getAttrLockState

@Stability(Stable)
@NotNull
public String getAttrLockState()

The lock state for the retention rule.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResourceType

@Stability(Stable)
@NotNull
public String getResourceType()

The resource type retained by the retention rule.

setResourceType

@Stability(Stable)
public void setResourceType(@NotNull
 String value)

The resource type retained by the retention rule.

getRetentionPeriod

@Stability(Stable)
@NotNull
public Object getRetentionPeriod()

The retention period of the rule.

setRetentionPeriod

@Stability(Stable)
public void setRetentionPeriod(@NotNull
 IResolvable value)

The retention period of the rule.

setRetentionPeriod

@Stability(Stable)
public void setRetentionPeriod(@NotNull
 CfnRule.RetentionPeriodProperty value)

The retention period of the rule.

getDescription

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

The description of the retention rule.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the retention rule.

getExcludeResourceTags

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

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

setExcludeResourceTags

@Stability(Stable)
public void setExcludeResourceTags(@Nullable
 IResolvable value)

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

setExcludeResourceTags

@Stability(Stable)
public void setExcludeResourceTags(@Nullable
 List<Object> value)

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

getLockConfiguration

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

setLockConfiguration

@Stability(Stable)
public void setLockConfiguration(@Nullable
 IResolvable value)

setLockConfiguration

@Stability(Stable)
public void setLockConfiguration(@Nullable
 CfnRule.UnlockDelayProperty value)

getResourceTags

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

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

setResourceTags

@Stability(Stable)
public void setResourceTags(@Nullable
 IResolvable value)

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

setResourceTags

@Stability(Stable)
public void setResourceTags(@Nullable
 List<Object> value)

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

getStatus

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

The state of the retention rule.

setStatus

@Stability(Stable)
public void setStatus(@Nullable
 String value)

The state of the retention rule.

getTags

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

Information about the tags assigned to the retention rule.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

Information about the tags assigned to the retention rule.