Package software.amazon.awssdk.services.s3.model

Class Destination

java.lang.Object

software.amazon.awssdk.services.s3.model.Destination

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Destination.Builder,Destination>

@Generated("software.amazon.awssdk:codegen")
public final class Destination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Destination.Builder,Destination>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Destination.Builder

Method Summary

Modifier and Type	Method	Description
AccessControlTranslation	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.
String	account()	Destination bucket owner account ID.
String	bucket()	The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
static Destination.Builder	builder()
EncryptionConfiguration	encryptionConfiguration()	A container that provides information about encryption.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Metrics	metrics()	A container specifying replication metrics-related settings enabling replication metrics and events.
ReplicationTime	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.
List<SdkField<?>>	sdkFields()
static Class<? extends Destination.Builder>	serializableBuilderClass()
StorageClass	storageClass()	The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.
String	storageClassAsString()	The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.
Destination.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

bucket

public final String bucket()

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

Returns:

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

account

public final String account()

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:

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.

storageClass

public final StorageClass 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.

If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

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.

See Also:

StorageClass

storageClassAsString

public final String storageClassAsString()

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.

If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

Returns:

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.

See Also:

StorageClass

accessControlTranslation

public final AccessControlTranslation 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:

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.

encryptionConfiguration

public final EncryptionConfiguration encryptionConfiguration()

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

Returns:

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

replicationTime

public final ReplicationTime 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:

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.

metrics

public final Metrics metrics()

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

Returns:

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

toBuilder

public Destination.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Destination.Builder,Destination>

builder

public static Destination.Builder builder()

serializableBuilderClass

public static Class<? extends Destination.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo