Package software.amazon.awssdk.services.dlm.model

Interface CreateRule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CreateRule.Builder,CreateRule>, SdkBuilder<CreateRule.Builder,CreateRule>, SdkPojo
Enclosing class:
CreateRule
public static interface CreateRule.Builder extends SdkPojo, CopyableBuilder<CreateRule.Builder,CreateRule>

  • Method Details

    • location

      CreateRule.Builder location(String location)

      [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

      If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

      Parameters:
      location - [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

      If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

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

    • location

      CreateRule.Builder location(LocationValues location)

      [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

      If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

      Parameters:
      location - [Snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

      If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

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

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

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

    • 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 Cron expressions in the Amazon CloudWatch 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 Cron expressions in the Amazon CloudWatch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scripts

      CreateRule.Builder scripts(Collection<Script> scripts)

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

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

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