Package software.amazon.awssdk.services.s3.model

Interface ReplicationRule.Builder

    • Method Detail

      • 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. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination 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 Replication in the Amazon S3 User Guide.

        Parameters:
        priority - The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination 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 Replication 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.

        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 a bucket, specify an empty string.

        Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        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 a bucket, specify an empty string.

        Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

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

      • filter

        ReplicationRule.Builder filter​(ReplicationRuleFilter filter)
        Sets the value of the Filter property for this object.
        Parameters:
        filter - The new value for the Filter property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceSelectionCriteria

        ReplicationRule.Builder sourceSelectionCriteria​(SourceSelectionCriteria sourceSelectionCriteria)

        A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

        Parameters:
        sourceSelectionCriteria - A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • existingObjectReplication

        ReplicationRule.Builder existingObjectReplication​(ExistingObjectReplication existingObjectReplication)

        Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.

        Parameters:
        existingObjectReplication - Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destination

        ReplicationRule.Builder destination​(Destination destination)

        A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

        Parameters:
        destination - A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deleteMarkerReplication

        ReplicationRule.Builder deleteMarkerReplication​(DeleteMarkerReplication deleteMarkerReplication)
        Sets the value of the DeleteMarkerReplication property for this object.
        Parameters:
        deleteMarkerReplication - The new value for the DeleteMarkerReplication property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.