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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Destination data as a hash:

{
  bucket: "BucketName", # required
  account: "AccountId",
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
  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).

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

Returns:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#account ⇒ String

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services 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 S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html

Returns:

  • (String) 


3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#bucket ⇒ String

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

Returns:

  • (String) 


3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Types::Metrics

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

Returns:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#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 S3 API Reference*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html

Returns:

  • (String) 


3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/aws-sdk-s3/types.rb', line 3719

class Destination < Struct.new(
  :bucket,
  :account,
  :storage_class,
  :access_control_translation,
  :encryption_configuration,
  :replication_time,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end