Interface ReplicationRule.Builder

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

  • Method Details

    • id

      ReplicationRule.Builder id(String id)

      A unique identifier for the rule. The maximum value is 255 characters.

      Parameters:
      id - A unique identifier for the rule. The maximum value is 255 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      ReplicationRule.Builder priority(Integer priority)

      The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

      For more information, see Creating replication rules on Outposts in the Amazon S3 User Guide.

      Parameters:
      priority - The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

      For more information, see Creating replication rules on Outposts in the Amazon S3 User Guide.

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

    • prefix

      @Deprecated ReplicationRule.Builder prefix(String prefix)
      Deprecated.
      Prefix has been deprecated

      An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in an Outposts bucket, specify an empty string.

      When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.

      Parameters:
      prefix - An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in an Outposts bucket, specify an empty string.

      When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.

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

    • filter

      ReplicationRule.Builder filter(ReplicationRuleFilter filter)

      A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.

      Parameters:
      filter - A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default ReplicationRule.Builder filter(Consumer<ReplicationRuleFilter.Builder> filter)

      A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.

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

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

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

    • status

      ReplicationRule.Builder status(String status)

      Specifies whether the rule is enabled.

      Parameters:
      status - Specifies whether the rule is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ReplicationRule.Builder status(ReplicationRuleStatus status)

      Specifies whether the rule is enabled.

      Parameters:
      status - Specifies whether the rule is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceSelectionCriteria

      ReplicationRule.Builder sourceSelectionCriteria(SourceSelectionCriteria sourceSelectionCriteria)

      A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.

      Parameters:
      sourceSelectionCriteria - A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceSelectionCriteria

      default ReplicationRule.Builder sourceSelectionCriteria(Consumer<SourceSelectionCriteria.Builder> sourceSelectionCriteria)

      A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.

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

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

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

    • existingObjectReplication

      ReplicationRule.Builder existingObjectReplication(ExistingObjectReplication existingObjectReplication)

      An optional configuration to replicate existing source bucket objects.

      This is not supported by Amazon S3 on Outposts buckets.

      Parameters:
      existingObjectReplication - An optional configuration to replicate existing source bucket objects.

      This is not supported by Amazon S3 on Outposts buckets.

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

    • existingObjectReplication

      default ReplicationRule.Builder existingObjectReplication(Consumer<ExistingObjectReplication.Builder> existingObjectReplication)

      An optional configuration to replicate existing source bucket objects.

      This is not supported by Amazon S3 on Outposts buckets.

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

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

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

    • destination

      ReplicationRule.Builder destination(Destination destination)

      A container for information about the replication destination and its configurations.

      Parameters:
      destination - A container for information about the replication destination and its configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default ReplicationRule.Builder destination(Consumer<Destination.Builder> destination)

      A container for information about the replication destination and its configurations.

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

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

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

    • deleteMarkerReplication

      ReplicationRule.Builder deleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)

      Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.

      For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.

      Parameters:
      deleteMarkerReplication - Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.

      For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.

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

    • deleteMarkerReplication

      default ReplicationRule.Builder deleteMarkerReplication(Consumer<DeleteMarkerReplication.Builder> deleteMarkerReplication)

      Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.

      For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.

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

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

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

    • bucket

      ReplicationRule.Builder bucket(String bucket)

      The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.

      Parameters:
      bucket - The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.