software.amazon.awscdk.services.dlm

Interface CfnLifecyclePolicy.ScheduleProperty

All Known Implementing Classes:

CfnLifecyclePolicy.ScheduleProperty.Jsii$Proxy

Enclosing class:

CfnLifecyclePolicy

public static interface CfnLifecyclePolicy.ScheduleProperty

Specifies a backup 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()
         .copyTags(false)
         .createRule(CreateRuleProperty.builder()
                 .cronExpression("cronExpression")
                 .interval(123)
                 .intervalUnit("intervalUnit")
                 .location("location")
                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLifecyclePolicy.ScheduleProperty.Builder	builder()
default java.lang.Object	getCopyTags() Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
default java.lang.Object	getCreateRule() The creation rule.
default java.lang.Object	getCrossRegionCopyRules() The rule for cross-Region snapshot copies.
default java.lang.Object	getDeprecateRule() The AMI deprecation rule for the schedule.
default java.lang.Object	getFastRestoreRule() The rule for enabling fast snapshot restore.
default java.lang.String	getName() The name of the schedule.
default java.lang.Object	getRetainRule() The retention rule.
default java.lang.Object	getShareRules() The rule for sharing snapshots with other AWS accounts .
default java.lang.Object	getTagsToAdd() The tags to apply to policy-created resources.
default java.lang.Object	getVariableTags() A collection of key/value pairs with values determined dynamically when the policy is executed.

Method Detail

getCopyTags

default java.lang.Object getCopyTags()

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

getCreateRule

default java.lang.Object getCreateRule()

The creation rule.

getCrossRegionCopyRules

default java.lang.Object getCrossRegionCopyRules()

The rule for cross-Region snapshot copies.

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

getDeprecateRule

default java.lang.Object getDeprecateRule()

The AMI deprecation rule for the schedule.

getFastRestoreRule

default java.lang.Object getFastRestoreRule()

The rule for enabling fast snapshot restore.

getName

default java.lang.String getName()

The name of the schedule.

getRetainRule

default java.lang.Object getRetainRule()

The retention rule.

getShareRules

default java.lang.Object getShareRules()

The rule for sharing snapshots with other AWS accounts .

getTagsToAdd

default java.lang.Object getTagsToAdd()

The tags to apply to policy-created resources.

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

getVariableTags

default java.lang.Object getVariableTags()

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.

builder

static CfnLifecyclePolicy.ScheduleProperty.Builder builder()

Returns:

a CfnLifecyclePolicy.ScheduleProperty.Builder of CfnLifecyclePolicy.ScheduleProperty