Skip to content

Destination

Source code in docs_src/capo_s3/types/destination.py
class Destination(TypedDict, closed=True):
    bucket: "capo_s3.types.bucket_name.BucketName"
    """<p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.</p>"""
    account: NotRequired["capo_s3.types.account_id.AccountId"]
    """<p>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 <code>AccessControlTranslation</code> property, this is the account ID of the destination bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html">Replication Additional Configuration: Changing the Replica Owner</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    storage_class: NotRequired["capo_s3.types.storage_class.StorageClass"]
    """<p> 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. </p> <p>For valid values, see the <code>StorageClass</code> element of the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html">PUT Bucket replication</a> action in the <i>Amazon S3 API Reference</i>.</p> <p> <code>FSX_OPENZFS</code> is not an accepted value when replicating objects.</p>"""
    access_control_translation: NotRequired[
        "capo_s3.types.access_control_translation.AccessControlTranslation"
    ]
    """<p>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.</p>"""
    encryption_configuration: NotRequired[
        "capo_s3.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>A container that provides information about encryption. If <code>SourceSelectionCriteria</code> is specified, you must specify this element.</p>"""
    replication_time: NotRequired["capo_s3.types.replication_time.ReplicationTime"]
    """<p> 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 <code>Metrics</code> block. </p>"""
    metrics: NotRequired["capo_s3.types.metrics.Metrics"]
    """<p> A container specifying replication metrics-related settings enabling replication metrics and events. </p>"""

access_control_translation instance-attribute

access_control_translation: NotRequired[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.

account instance-attribute

account: NotRequired[AccountId]

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.

bucket instance-attribute

bucket: BucketName

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

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

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

metrics instance-attribute

metrics: NotRequired[Metrics]

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

replication_time instance-attribute

replication_time: NotRequired[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.

storage_class instance-attribute

storage_class: NotRequired[StorageClass]

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.

FSX_OPENZFS is not an accepted value when replicating objects.