You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::Destination

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Destination as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  account: "AccountId",
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
  access_control_translation: {
    owner: "Destination", # required, accepts Destination
  },
  encryption_configuration: {
    replica_kms_key_id: "ReplicaKmsKeyID",
  },
  replication_time: {
    status: "Enabled", # required, accepts Enabled, Disabled
    time: { # required
      minutes: 1,
    },
  },
  metrics: {
    status: "Enabled", # required, accepts Enabled, Disabled
    event_threshold: {
      minutes: 1,
    },
  },
}

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_translation ⇒ Types::AccessControlTranslation

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.

Returns:

  • (Types::AccessControlTranslation) —

    Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket.

#account ⇒ String

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    Destination bucket owner account ID.

#bucket ⇒ String

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

#encryption_configuration ⇒ Types::EncryptionConfiguration

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

Returns:

#metrics ⇒ Types::Metrics

A container specifying replication metrics-related settings enabling replication metrics and events.

Returns:

  • (Types::Metrics) —

    A container specifying replication metrics-related settings enabling replication metrics and events.

#replication_time ⇒ Types::ReplicationTime

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.

Returns:

  • (Types::ReplicationTime) —

    A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated.

#storage_class ⇒ String

The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon Simple Storage Service API Reference.

Returns:

  • (String) —

    The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.