Package software.amazon.awscdk.services.rbin

Class CfnRule.Builder

java.lang.Object

software.amazon.awscdk.services.rbin.CfnRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRule>

Enclosing class:

CfnRule

@Stability(Stable)
public static final class CfnRule.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRule>

A fluent builder for CfnRule.

Method Summary

Modifier and Type	Method	Description
CfnRule	build()
static CfnRule.Builder	create(software.constructs.Construct scope, String id)
CfnRule.Builder	description(String description)	The description of the retention rule.
CfnRule.Builder	excludeResourceTags(List<? extends Object> excludeResourceTags)	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
CfnRule.Builder	excludeResourceTags(IResolvable excludeResourceTags)	Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
CfnRule.Builder	lockConfiguration(IResolvable lockConfiguration)
CfnRule.Builder	lockConfiguration(CfnRule.UnlockDelayProperty lockConfiguration)
CfnRule.Builder	resourceTags(List<? extends Object> resourceTags)	Information about the resource tags used to identify resources that are retained by the retention rule.
CfnRule.Builder	resourceTags(IResolvable resourceTags)	Information about the resource tags used to identify resources that are retained by the retention rule.
CfnRule.Builder	resourceType(String resourceType)	The resource type retained by the retention rule.
CfnRule.Builder	retentionPeriod(IResolvable retentionPeriod)	The retention period of the rule.
CfnRule.Builder	retentionPeriod(CfnRule.RetentionPeriodProperty retentionPeriod)	The retention period of the rule.
CfnRule.Builder	status(String status)	The state of the retention rule.
CfnRule.Builder	tags(List<? extends CfnTag> tags)	Information about the tags assigned to the retention rule.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnRule.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnRule.Builder.

resourceType

@Stability(Stable)
public CfnRule.Builder resourceType(String resourceType)

The resource type retained by the retention rule.

Parameters:

resourceType - The resource type retained by the retention rule. This parameter is required.

Returns:

this

See Also:

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

retentionPeriod

@Stability(Stable)
public CfnRule.Builder retentionPeriod(IResolvable retentionPeriod)

The retention period of the rule.

Parameters:

retentionPeriod - The retention period of the rule. This parameter is required.

Returns:

this

See Also:

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

retentionPeriod

@Stability(Stable)
public CfnRule.Builder retentionPeriod(CfnRule.RetentionPeriodProperty retentionPeriod)

The retention period of the rule.

Parameters:

retentionPeriod - The retention period of the rule. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnRule.Builder description(String description)

The description of the retention rule.

Parameters:

description - The description of the retention rule. This parameter is required.

Returns:

this

See Also:

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

excludeResourceTags

@Stability(Stable)
public CfnRule.Builder excludeResourceTags(IResolvable excludeResourceTags)

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

Parameters:

excludeResourceTags - Information about the exclude resource tags used to identify resources that are excluded by the retention rule. This parameter is required.

Returns:

this

See Also:

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

excludeResourceTags

@Stability(Stable)
public CfnRule.Builder excludeResourceTags(List<? extends Object> excludeResourceTags)

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

Parameters:

excludeResourceTags - Information about the exclude resource tags used to identify resources that are excluded by the retention rule. This parameter is required.

Returns:

this

See Also:

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

lockConfiguration

@Stability(Stable)
public CfnRule.Builder lockConfiguration(IResolvable lockConfiguration)

Parameters:

lockConfiguration - This parameter is required.

Returns:

this

See Also:

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

lockConfiguration

@Stability(Stable)
public CfnRule.Builder lockConfiguration(CfnRule.UnlockDelayProperty lockConfiguration)

Parameters:

lockConfiguration - This parameter is required.

Returns:

this

See Also:

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

resourceTags

@Stability(Stable)
public CfnRule.Builder resourceTags(IResolvable resourceTags)

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

Parameters:

resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule. This parameter is required.

Returns:

this

See Also:

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

resourceTags

@Stability(Stable)
public CfnRule.Builder resourceTags(List<? extends Object> resourceTags)

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

Parameters:

resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule. This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnRule.Builder status(String status)

The state of the retention rule.

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

Parameters:

status - The state of the retention rule. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnRule.Builder tags(List<? extends CfnTag> tags)

Information about the tags assigned to the retention rule.

Parameters:

tags - Information about the tags assigned to the retention rule. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnRule build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRule>

Returns:

a newly built instance of CfnRule.