software.amazon.awssdk.services.dlm.model

Interface Schedule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Schedule.Builder,Schedule>, SdkBuilder<Schedule.Builder,Schedule>, SdkPojo

Enclosing class:

Schedule

public static interface Schedule.Builder
extends SdkPojo, CopyableBuilder<Schedule.Builder,Schedule>

Method Summary

Modifier and Type	Method and Description
Schedule.Builder	copyTags(Boolean copyTags) Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
default Schedule.Builder	createRule(Consumer<CreateRule.Builder> createRule) The creation rule.
Schedule.Builder	createRule(CreateRule createRule) The creation rule.
Schedule.Builder	crossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules) The rule for cross-Region snapshot copies.
Schedule.Builder	crossRegionCopyRules(Consumer<CrossRegionCopyRule.Builder>... crossRegionCopyRules) The rule for cross-Region snapshot copies.
Schedule.Builder	crossRegionCopyRules(CrossRegionCopyRule... crossRegionCopyRules) The rule for cross-Region snapshot copies.
default Schedule.Builder	fastRestoreRule(Consumer<FastRestoreRule.Builder> fastRestoreRule) The rule for enabling fast snapshot restore.
Schedule.Builder	fastRestoreRule(FastRestoreRule fastRestoreRule) The rule for enabling fast snapshot restore.
Schedule.Builder	name(String name) The name of the schedule.
default Schedule.Builder	retainRule(Consumer<RetainRule.Builder> retainRule) The retention rule.
Schedule.Builder	retainRule(RetainRule retainRule) The retention rule.
Schedule.Builder	tagsToAdd(Collection<Tag> tagsToAdd) The tags to apply to policy-created resources.
Schedule.Builder	tagsToAdd(Consumer<Tag.Builder>... tagsToAdd) The tags to apply to policy-created resources.
Schedule.Builder	tagsToAdd(Tag... tagsToAdd) The tags to apply to policy-created resources.
Schedule.Builder	variableTags(Collection<Tag> variableTags) A collection of key/value pairs with values determined dynamically when the policy is executed.
Schedule.Builder	variableTags(Consumer<Tag.Builder>... variableTags) A collection of key/value pairs with values determined dynamically when the policy is executed.
Schedule.Builder	variableTags(Tag... variableTags) A collection of key/value pairs with values determined dynamically when the policy is executed.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

Schedule.Builder name(String name)

The name of the schedule.

Parameters:

name - The name of the schedule.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyTags

Schedule.Builder copyTags(Boolean copyTags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tagsToAdd

Schedule.Builder tagsToAdd(Collection<Tag> tagsToAdd)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tagsToAdd

Schedule.Builder tagsToAdd(Tag... tagsToAdd)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tagsToAdd

Schedule.Builder tagsToAdd(Consumer<Tag.Builder>... tagsToAdd)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagsToAdd(List).

Parameters:

tagsToAdd - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tagsToAdd(List)

variableTags

Schedule.Builder variableTags(Collection<Tag> variableTags)

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.

Parameters:

variableTags - 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:

Returns a reference to this object so that method calls can be chained together.

variableTags

Schedule.Builder variableTags(Tag... variableTags)

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.

Parameters:

variableTags - 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:

Returns a reference to this object so that method calls can be chained together.

variableTags

Schedule.Builder variableTags(Consumer<Tag.Builder>... variableTags)

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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #variableTags(List).

Parameters:

variableTags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#variableTags(List)

createRule

Schedule.Builder createRule(CreateRule createRule)

The creation rule.

Parameters:

createRule - The creation rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

createRule

default Schedule.Builder createRule(Consumer<CreateRule.Builder> createRule)

The creation rule.

This is a convenience that creates an instance of the CreateRule.Builder avoiding the need to create one manually via CreateRule.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createRule(CreateRule).

Parameters:

createRule - a consumer that will call methods on CreateRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

createRule(CreateRule)

retainRule

Schedule.Builder retainRule(RetainRule retainRule)

The retention rule.

Parameters:

retainRule - The retention rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

retainRule

default Schedule.Builder retainRule(Consumer<RetainRule.Builder> retainRule)

The retention rule.

This is a convenience that creates an instance of the RetainRule.Builder avoiding the need to create one manually via RetainRule.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retainRule(RetainRule).

Parameters:

retainRule - a consumer that will call methods on RetainRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retainRule(RetainRule)

fastRestoreRule

Schedule.Builder fastRestoreRule(FastRestoreRule fastRestoreRule)

The rule for enabling fast snapshot restore.

Parameters:

fastRestoreRule - The rule for enabling fast snapshot restore.

Returns:

Returns a reference to this object so that method calls can be chained together.

fastRestoreRule

default Schedule.Builder fastRestoreRule(Consumer<FastRestoreRule.Builder> fastRestoreRule)

The rule for enabling fast snapshot restore.

This is a convenience that creates an instance of the FastRestoreRule.Builder avoiding the need to create one manually via FastRestoreRule.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fastRestoreRule(FastRestoreRule).

Parameters:

fastRestoreRule - a consumer that will call methods on FastRestoreRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

fastRestoreRule(FastRestoreRule)

crossRegionCopyRules

Schedule.Builder crossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules)

The rule for cross-Region snapshot copies.

Parameters:

crossRegionCopyRules - The rule for cross-Region snapshot copies.

Returns:

Returns a reference to this object so that method calls can be chained together.

crossRegionCopyRules

Schedule.Builder crossRegionCopyRules(CrossRegionCopyRule... crossRegionCopyRules)

The rule for cross-Region snapshot copies.

Parameters:

crossRegionCopyRules - The rule for cross-Region snapshot copies.

Returns:

Returns a reference to this object so that method calls can be chained together.

crossRegionCopyRules

Schedule.Builder crossRegionCopyRules(Consumer<CrossRegionCopyRule.Builder>... crossRegionCopyRules)

The rule for cross-Region snapshot copies.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #crossRegionCopyRules(List).

Parameters:

crossRegionCopyRules - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#crossRegionCopyRules(List)