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:

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Destination.Builder,Destination>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.