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

Class CfnRulePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.rbin.CfnRulePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRulePropsMixin>

Enclosing class:

CfnRulePropsMixin

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

A fluent builder for CfnRulePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnRulePropsMixin	build()
static CfnRulePropsMixin.Builder	create()
static CfnRulePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnRulePropsMixin.Builder	description(String description)	The retention rule description.
CfnRulePropsMixin.Builder	excludeResourceTags(List<? extends Object> excludeResourceTags)	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
CfnRulePropsMixin.Builder	excludeResourceTags(IResolvable excludeResourceTags)	[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.
CfnRulePropsMixin.Builder	lockConfiguration(CfnRulePropsMixin.UnlockDelayProperty lockConfiguration)	Information about the retention rule lock configuration.
CfnRulePropsMixin.Builder	lockConfiguration(IResolvable lockConfiguration)	Information about the retention rule lock configuration.
CfnRulePropsMixin.Builder	resourceTags(List<? extends Object> resourceTags)	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
CfnRulePropsMixin.Builder	resourceTags(IResolvable resourceTags)	[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
CfnRulePropsMixin.Builder	resourceType(String resourceType)	The resource type to be retained by the retention rule.
CfnRulePropsMixin.Builder	retentionPeriod(CfnRulePropsMixin.RetentionPeriodProperty retentionPeriod)	Information about the retention period for which the retention rule is to retain resources.
CfnRulePropsMixin.Builder	retentionPeriod(IResolvable retentionPeriod)	Information about the retention period for which the retention rule is to retain resources.
CfnRulePropsMixin.Builder	status(String status)	The state of the retention rule.
CfnRulePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Information about the tags to assign 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 CfnRulePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnRulePropsMixin.Builder.

create

@Stability(Stable)
public static CfnRulePropsMixin.Builder create()

Returns:

a new instance of CfnRulePropsMixin.Builder.

description

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

The retention rule description.

Parameters:

description - The retention rule description. 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 CfnRulePropsMixin.Builder excludeResourceTags(IResolvable excludeResourceTags)

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.

Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Parameters:

excludeResourceTags - [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level 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 CfnRulePropsMixin.Builder excludeResourceTags(List<? extends Object> excludeResourceTags)

[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule.

Resources that have any of these tags are not retained by the retention rule upon deletion.

You can't specify exclusion tags for tag-level retention rules.

Parameters:

excludeResourceTags - [Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level 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 CfnRulePropsMixin.Builder lockConfiguration(IResolvable lockConfiguration)

Information about the retention rule lock configuration.

Parameters:

lockConfiguration - Information about the retention rule lock configuration. 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 CfnRulePropsMixin.Builder lockConfiguration(CfnRulePropsMixin.UnlockDelayProperty lockConfiguration)

Information about the retention rule lock configuration.

Parameters:

lockConfiguration - Information about the retention rule lock configuration. 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 CfnRulePropsMixin.Builder resourceTags(IResolvable resourceTags)

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.

For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level 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 CfnRulePropsMixin.Builder resourceTags(List<? extends Object> resourceTags)

[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.

For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - [Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a tag-level 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

resourceType

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

The resource type to be retained by the retention rule.

Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.

• To retain EBS volumes, specify EBS_VOLUME .
• To retain EBS snapshots, specify EBS_SNAPSHOT
• To retain EBS-backed AMIs, specify EC2_IMAGE .

Parameters:

resourceType - The resource type to be 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 CfnRulePropsMixin.Builder retentionPeriod(IResolvable retentionPeriod)

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

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources. 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 CfnRulePropsMixin.Builder retentionPeriod(CfnRulePropsMixin.RetentionPeriodProperty retentionPeriod)

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

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources. 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

status

@Stability(Stable)
public CfnRulePropsMixin.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 CfnRulePropsMixin.Builder tags(List<? extends CfnTag> tags)

Information about the tags to assign to the retention rule.

Parameters:

tags - Information about the tags to assign 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 CfnRulePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnRulePropsMixin.