Class: Aws::S3Control::Types::ReplicationRule

Inherits:

Struct

• Object
• Struct
• Aws::S3Control::Types::ReplicationRule

Defined in:

gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Specifies which S3 on Outposts objects to replicate and where to store the replicas.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  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.

• #delete_marker_replication ⇒ Types::DeleteMarkerReplication

  Specifies whether S3 on Outposts replicates delete markers.

• #destination ⇒ Types::Destination

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

• #existing_object_replication ⇒ Types::ExistingObjectReplication

  An optional configuration to replicate existing source bucket objects.

• #filter ⇒ Types::ReplicationRuleFilter

  A filter that identifies the subset of objects to which the replication rule applies.

• #id ⇒ String

  A unique identifier for the rule.

• #prefix ⇒ String

  An object key name prefix that identifies the object or objects to which the rule applies.

• #priority ⇒ Integer

  The priority indicates which rule has precedence whenever two or more replication rules conflict.

• #source_selection_criteria ⇒ Types::SourceSelectionCriteria

  A container that describes additional filters for identifying the source Outposts objects that you want to replicate.

• #status ⇒ String

  Specifies whether the rule is enabled.

Instance Attribute Details

#bucket ⇒ String

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:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#delete_marker_replication ⇒ Types::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:

• (Types::DeleteMarkerReplication)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::Destination

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

Returns:

• (Types::Destination)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#existing_object_replication ⇒ Types::ExistingObjectReplication

An optional configuration to replicate existing source bucket objects.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

• (Types::ExistingObjectReplication)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::ReplicationRuleFilter

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:

• (Types::ReplicationRuleFilter)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

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:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#source_selection_criteria ⇒ Types::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:

• (Types::SourceSelectionCriteria)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies whether the rule is enabled.

Returns:

• (String)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6710

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication,
  :bucket)
  SENSITIVE = []
  include Aws::Structure
end