dlm/aws.sdk.kotlin.services.dlm.model/Schedule/Builder

Builder

Properties

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

copyTags

var copyTags: Boolean?

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

createRule

var createRule: CreateRule?

The creation rule.

crossRegionCopyRules

var crossRegionCopyRules: List<CrossRegionCopyRule>?

Specifies a rule for copying snapshots or AMIs across Regions.

deprecateRule

var deprecateRule: DeprecateRule?

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

fastRestoreRule

var fastRestoreRule: FastRestoreRule?

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

name

var name: String?

The name of the schedule.

retainRule

var retainRule: RetainRule?

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

shareRules

var shareRules: List<ShareRule>?

[Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.

tagsToAdd

var tagsToAdd: List<Tag>?

The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.

variableTags

var variableTags: List<Tag>?

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

Functions

archiveRule

fun archiveRule(block: ArchiveRule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dlm.model.ArchiveRule inside the given block

createRule

fun createRule(block: CreateRule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dlm.model.CreateRule inside the given block

deprecateRule

fun deprecateRule(block: DeprecateRule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dlm.model.DeprecateRule inside the given block

fastRestoreRule

fun fastRestoreRule(block: FastRestoreRule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dlm.model.FastRestoreRule inside the given block

retainRule

fun retainRule(block: RetainRule.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dlm.model.RetainRule inside the given block