Package software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.ScheduleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicy.ScheduleProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

@Stability(Stable)
public static interface CfnLifecyclePolicy.ScheduleProperty
extends software.amazon.jsii.JsiiSerializable

[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.

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.dlm.*;
 ScheduleProperty scheduleProperty = ScheduleProperty.builder()
         .archiveRule(ArchiveRuleProperty.builder()
                 .retainRule(ArchiveRetainRuleProperty.builder()
                         .retentionArchiveTier(RetentionArchiveTierProperty.builder()
                                 .count(123)
                                 .interval(123)
                                 .intervalUnit("intervalUnit")
                                 .build())
                         .build())
                 .build())
         .copyTags(false)
         .createRule(CreateRuleProperty.builder()
                 .cronExpression("cronExpression")
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .location("location")
                 .scripts(List.of(ScriptProperty.builder()
                         .executeOperationOnScriptFailure(false)
                         .executionHandler("executionHandler")
                         .executionHandlerService("executionHandlerService")
                         .executionTimeout(123)
                         .maximumRetryCount(123)
                         .stages(List.of("stages"))
                         .build()))
                 .times(List.of("times"))
                 .build())
         .crossRegionCopyRules(List.of(CrossRegionCopyRuleProperty.builder()
                 .encrypted(false)
                 // the properties below are optional
                 .cmkArn("cmkArn")
                 .copyTags(false)
                 .deprecateRule(CrossRegionCopyDeprecateRuleProperty.builder()
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .build())
                 .retainRule(CrossRegionCopyRetainRuleProperty.builder()
                         .interval(123)
                         .intervalUnit("intervalUnit")
                         .build())
                 .target("target")
                 .targetRegion("targetRegion")
                 .build()))
         .deprecateRule(DeprecateRuleProperty.builder()
                 .count(123)
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .build())
         .fastRestoreRule(FastRestoreRuleProperty.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .count(123)
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .build())
         .name("name")
         .retainRule(RetainRuleProperty.builder()
                 .count(123)
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .build())
         .shareRules(List.of(ShareRuleProperty.builder()
                 .targetAccounts(List.of("targetAccounts"))
                 .unshareInterval(123)
                 .unshareIntervalUnit("unshareIntervalUnit")
                 .build()))
         .tagsToAdd(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variableTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicy.ScheduleProperty.Builder	builder()
default Object	getArchiveRule()	[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule.
default Object	getCopyTags()	Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
default Object	getCreateRule()	The creation rule.
default Object	getCrossRegionCopyRules()	Specifies a rule for copying snapshots or AMIs across Regions.
default Object	getDeprecateRule()	[Custom AMI policies only] The AMI deprecation rule for the schedule.
default Object	getFastRestoreRule()	[Custom snapshot policies only] The rule for enabling fast snapshot restore.
default String	getName()	The name of the schedule.
default Object	getRetainRule()	The retention rule for snapshots or AMIs created by the policy.
default Object	getShareRules()	[Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts .
default Object	getTagsToAdd()	The tags to apply to policy-created resources.
default Object	getVariableTags()	[AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArchiveRule

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

[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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule

getCopyTags

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-copytags

getCreateRule

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

The creation rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-createrule

getCrossRegionCopyRules

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

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 or in a Local Zone. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-crossregioncopyrules

getDeprecateRule

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-deprecaterule

getFastRestoreRule

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-fastrestorerule

getName

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

The name of the schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-name

getRetainRule

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-retainrule

getShareRules

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-sharerules

getTagsToAdd

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

The tags to apply to policy-created resources.

These user-defined tags are in addition to the AWS -added lifecycle tags.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-tagstoadd

getVariableTags

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

[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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-variabletags

builder

@Stability(Stable)
static CfnLifecyclePolicy.ScheduleProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.ScheduleProperty.Builder of CfnLifecyclePolicy.ScheduleProperty