Package software.amazon.awscdk.services.dlm

Class CfnLifecyclePolicy.ScheduleProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.ScheduleProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLifecyclePolicy.ScheduleProperty>

Enclosing interface:

CfnLifecyclePolicy.ScheduleProperty

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

A builder for CfnLifecyclePolicy.ScheduleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLifecyclePolicy.ScheduleProperty.Builder	archiveRule(IResolvable archiveRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getArchiveRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	archiveRule(CfnLifecyclePolicy.ArchiveRuleProperty archiveRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getArchiveRule()
CfnLifecyclePolicy.ScheduleProperty	build()	Builds the configured instance.
CfnLifecyclePolicy.ScheduleProperty.Builder	copyTags(Boolean copyTags)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCopyTags()
CfnLifecyclePolicy.ScheduleProperty.Builder	copyTags(IResolvable copyTags)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCopyTags()
CfnLifecyclePolicy.ScheduleProperty.Builder	createRule(IResolvable createRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCreateRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	createRule(CfnLifecyclePolicy.CreateRuleProperty createRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCreateRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	crossRegionCopyRules(List<? extends Object> crossRegionCopyRules)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCrossRegionCopyRules()
CfnLifecyclePolicy.ScheduleProperty.Builder	crossRegionCopyRules(IResolvable crossRegionCopyRules)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCrossRegionCopyRules()
CfnLifecyclePolicy.ScheduleProperty.Builder	deprecateRule(IResolvable deprecateRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getDeprecateRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	deprecateRule(CfnLifecyclePolicy.DeprecateRuleProperty deprecateRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getDeprecateRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	fastRestoreRule(IResolvable fastRestoreRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getFastRestoreRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	fastRestoreRule(CfnLifecyclePolicy.FastRestoreRuleProperty fastRestoreRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getFastRestoreRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	name(String name)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getName()
CfnLifecyclePolicy.ScheduleProperty.Builder	retainRule(IResolvable retainRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getRetainRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	retainRule(CfnLifecyclePolicy.RetainRuleProperty retainRule)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getRetainRule()
CfnLifecyclePolicy.ScheduleProperty.Builder	shareRules(List<? extends Object> shareRules)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getShareRules()
CfnLifecyclePolicy.ScheduleProperty.Builder	shareRules(IResolvable shareRules)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getShareRules()
CfnLifecyclePolicy.ScheduleProperty.Builder	tagsToAdd(List<? extends Object> tagsToAdd)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getTagsToAdd()
CfnLifecyclePolicy.ScheduleProperty.Builder	tagsToAdd(IResolvable tagsToAdd)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getTagsToAdd()
CfnLifecyclePolicy.ScheduleProperty.Builder	variableTags(List<? extends Object> variableTags)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getVariableTags()
CfnLifecyclePolicy.ScheduleProperty.Builder	variableTags(IResolvable variableTags)	Sets the value of CfnLifecyclePolicy.ScheduleProperty.getVariableTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

archiveRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder archiveRule(IResolvable archiveRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getArchiveRule()

Parameters:

archiveRule - [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

Returns:

this

archiveRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder archiveRule(CfnLifecyclePolicy.ArchiveRuleProperty archiveRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getArchiveRule()

Parameters:

archiveRule - [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies .

Returns:

this

copyTags

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder copyTags(Boolean copyTags)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCopyTags()

Parameters:

copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Returns:

this

copyTags

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder copyTags(IResolvable copyTags)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCopyTags()

Parameters:

copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Returns:

this

createRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder createRule(IResolvable createRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCreateRule()

Parameters:

createRule - The creation rule.

Returns:

this

createRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder createRule(CfnLifecyclePolicy.CreateRuleProperty createRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCreateRule()

Parameters:

createRule - The creation rule.

Returns:

this

crossRegionCopyRules

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder crossRegionCopyRules(IResolvable crossRegionCopyRules)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCrossRegionCopyRules()

Parameters:

crossRegionCopyRules - Specifies a rule for copying snapshots or AMIs across regions.

You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Returns:

this

crossRegionCopyRules

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder crossRegionCopyRules(List<? extends Object> crossRegionCopyRules)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getCrossRegionCopyRules()

Parameters:

crossRegionCopyRules - Specifies a rule for copying snapshots or AMIs across regions.

You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Returns:

this

deprecateRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder deprecateRule(IResolvable deprecateRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getDeprecateRule()

Parameters:

deprecateRule - [Custom AMI policies only] The AMI deprecation rule for the schedule.

Returns:

this

deprecateRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder deprecateRule(CfnLifecyclePolicy.DeprecateRuleProperty deprecateRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getDeprecateRule()

Parameters:

deprecateRule - [Custom AMI policies only] The AMI deprecation rule for the schedule.

Returns:

this

fastRestoreRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder fastRestoreRule(IResolvable fastRestoreRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getFastRestoreRule()

Parameters:

fastRestoreRule - [Custom snapshot policies only] The rule for enabling fast snapshot restore.

Returns:

this

fastRestoreRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder fastRestoreRule(CfnLifecyclePolicy.FastRestoreRuleProperty fastRestoreRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getFastRestoreRule()

Parameters:

fastRestoreRule - [Custom snapshot policies only] The rule for enabling fast snapshot restore.

Returns:

this

name

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder name(String name)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getName()

Parameters:

name - The name of the schedule.

Returns:

this

retainRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder retainRule(IResolvable retainRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getRetainRule()

Parameters:

retainRule - The retention rule for snapshots or AMIs created by the policy.

Returns:

this

retainRule

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder retainRule(CfnLifecyclePolicy.RetainRuleProperty retainRule)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getRetainRule()

Parameters:

retainRule - The retention rule for snapshots or AMIs created by the policy.

Returns:

this

shareRules

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder shareRules(IResolvable shareRules)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getShareRules()

Parameters:

shareRules - [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts .

Returns:

this

shareRules

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder shareRules(List<? extends Object> shareRules)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getShareRules()

Parameters:

shareRules - [Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts .

Returns:

this

tagsToAdd

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder tagsToAdd(IResolvable tagsToAdd)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getTagsToAdd()

Parameters:

tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS -added lifecycle tags.

Returns:

this

tagsToAdd

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder tagsToAdd(List<? extends Object> tagsToAdd)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getTagsToAdd()

Parameters:

tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS -added lifecycle tags.

Returns:

this

variableTags

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder variableTags(IResolvable variableTags)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getVariableTags()

Parameters:

variableTags - [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp) . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Returns:

this

variableTags

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty.Builder variableTags(List<? extends Object> variableTags)

Sets the value of CfnLifecyclePolicy.ScheduleProperty.getVariableTags()

Parameters:

variableTags - [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp) . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Returns:

this

build

@Stability(Stable)
public CfnLifecyclePolicy.ScheduleProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLifecyclePolicy.ScheduleProperty>

Returns:

a new instance of CfnLifecyclePolicy.ScheduleProperty

Throws:

NullPointerException - if any required attribute was not provided