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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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).

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

#accountString

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.

Returns:

  • (String)


3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

#bucketString

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

Returns:

  • (String)


3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

#encryption_configurationTypes::EncryptionConfiguration

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



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

#metricsTypes::Metrics

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

Returns:



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

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



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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

#storage_classString

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.

Returns:

  • (String)


3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3268

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