Interface CreateRule.Builder

All Superinterfaces:

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

Enclosing class:

CreateRule

@Mutable
@NotThreadSafe
public static interface CreateRule.Builder
extends SdkPojo, CopyableBuilder<CreateRule.Builder,CreateRule>

Method Summary

Modifier and Type	Method	Description
CreateRule.Builder	cronExpression(String cronExpression)	The schedule, as a Cron expression.
CreateRule.Builder	interval(Integer interval)	The interval between snapshots.
CreateRule.Builder	intervalUnit(String intervalUnit)	The interval unit.
CreateRule.Builder	intervalUnit(IntervalUnitValues intervalUnit)	The interval unit.
CreateRule.Builder	location(String location)	[Custom snapshot policies only] Specifies the destination for snapshots created by the policy.
CreateRule.Builder	location(LocationValues location)	[Custom snapshot policies only] Specifies the destination for snapshots created by the policy.
CreateRule.Builder	scripts(Collection<Script> scripts)	[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances.
CreateRule.Builder	scripts(Consumer<Script.Builder>... scripts)	[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances.
CreateRule.Builder	scripts(Script... scripts)	[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances.
CreateRule.Builder	times(String... times)	The time, in UTC, to start the operation.
CreateRule.Builder	times(Collection<String> times)	The time, in UTC, to start the operation.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

location

CreateRule.Builder location(String location)

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

• If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.

• If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.

• If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

Specify one of the following values:

• To create snapshots in the same Region as the source resource, specify CLOUD.

• To create snapshots in the same Local Zone as the source resource, specify LOCAL_ZONE.

• To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.

Default: CLOUD

Parameters:

location - [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

• If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.

• If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.

• If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

Specify one of the following values:

• To create snapshots in the same Region as the source resource, specify CLOUD.

• To create snapshots in the same Local Zone as the source resource, specify LOCAL_ZONE.

• To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.

Default: CLOUD

Returns:

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

See Also:

• LocationValues
• LocationValues

location

CreateRule.Builder location(LocationValues location)

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

• If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.

• If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.

• If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

Specify one of the following values:

• To create snapshots in the same Region as the source resource, specify CLOUD.

• To create snapshots in the same Local Zone as the source resource, specify LOCAL_ZONE.

• To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.

Default: CLOUD

Parameters:

location - [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The allowed destinations depend on the location of the targeted resources.

• If the policy targets resources in a Region, then you must create snapshots in the same Region as the source resource.

• If the policy targets resources in a Local Zone, you can create snapshots in the same Local Zone or in its parent Region.

• If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost or in its parent Region.

Specify one of the following values:

• To create snapshots in the same Region as the source resource, specify CLOUD.

• To create snapshots in the same Local Zone as the source resource, specify LOCAL_ZONE.

• To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL.

Default: CLOUD

Returns:

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

See Also:

• LocationValues
• LocationValues

interval

CreateRule.Builder interval(Integer interval)

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

Parameters:

interval - The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

Returns:

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

intervalUnit

CreateRule.Builder intervalUnit(String intervalUnit)

The interval unit.

Parameters:

intervalUnit - The interval unit.

Returns:

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

See Also:

• IntervalUnitValues
• IntervalUnitValues

intervalUnit

CreateRule.Builder intervalUnit(IntervalUnitValues intervalUnit)

The interval unit.

Parameters:

intervalUnit - The interval unit.

Returns:

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

See Also:

• IntervalUnitValues
• IntervalUnitValues

times

CreateRule.Builder times(Collection<String> times)

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

Parameters:

times - The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

Returns:

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

times

CreateRule.Builder times(String... times)

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

Parameters:

times - The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

Returns:

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

cronExpression

CreateRule.Builder cronExpression(String cronExpression)

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see the Cron expressions reference in the Amazon EventBridge User Guide.

Parameters:

cronExpression - The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see the Cron expressions reference in the Amazon EventBridge User Guide.

Returns:

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

scripts

CreateRule.Builder scripts(Collection<Script> scripts)

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Parameters:

scripts - [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Returns:

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

scripts

CreateRule.Builder scripts(Script... scripts)

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Parameters:

scripts - [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Returns:

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

scripts

CreateRule.Builder scripts(Consumer<Script.Builder>... scripts)

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

This is a convenience method that creates an instance of the Script.Builder avoiding the need to create one manually via Script.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scripts(List<Script>).

Parameters:

scripts - a consumer that will call methods on Script.Builder

Returns:

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

See Also:

• scripts(java.util.Collection<Script>)