Interface RuleSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RuleSummary.Builder,RuleSummary>, SdkBuilder<RuleSummary.Builder,RuleSummary>, SdkPojo
Enclosing class:
RuleSummary
@Mutable @NotThreadSafe public static interface RuleSummary.Builder extends SdkPojo, CopyableBuilder<RuleSummary.Builder,RuleSummary>

  • Method Details

    • identifier

      RuleSummary.Builder identifier(String identifier)

      The unique ID of the retention rule.

      Parameters:
      identifier - The unique ID of the retention rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      RuleSummary.Builder description(String description)

      The retention rule description.

      Parameters:
      description - The retention rule description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionPeriod

      RuleSummary.Builder retentionPeriod(RetentionPeriod retentionPeriod)

      Information about the retention period for which the retention rule is to retain resources.

      Parameters:
      retentionPeriod - Information about the retention period for which the retention rule is to retain resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionPeriod

      default RuleSummary.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)

      Information about the retention period for which the retention rule is to retain resources.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retentionPeriod(RetentionPeriod).

      Parameters:
      retentionPeriod - a consumer that will call methods on RetentionPeriod.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lockState

      RuleSummary.Builder lockState(String lockState)

      [Region-level retention rules only] The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Parameters:
      lockState - [Region-level retention rules only] The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

    • lockState

      RuleSummary.Builder lockState(LockState lockState)

      [Region-level retention rules only] The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      Parameters:
      lockState - [Region-level retention rules only] The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

    • ruleArn

      RuleSummary.Builder ruleArn(String ruleArn)

      The Amazon Resource Name (ARN) of the retention rule.

      Parameters:
      ruleArn - The Amazon Resource Name (ARN) of the retention rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.