Class S3Configuration

java.lang.Object
software.amazon.awssdk.services.timestreamwrite.model.S3Configuration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3Configuration.Builder,S3Configuration>
@Generated("software.amazon.awssdk:codegen") public final class S3Configuration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Configuration.Builder,S3Configuration>

The configuration that specifies an S3 location.

See Also:

  • Method Details

    • bucketName

      public final String bucketName()

      The bucket name of the customer S3 bucket.

      Returns:
      The bucket name of the customer S3 bucket.

    • objectKeyPrefix

      public final String objectKeyPrefix()

      The object key preview for the customer S3 location.

      Returns:
      The object key preview for the customer S3 location.

    • encryptionOption

      public final S3EncryptionOption encryptionOption()

      The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.

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

      Returns:
      The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.
      See Also:

    • encryptionOptionAsString

      public final String encryptionOptionAsString()

      The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.

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

      Returns:
      The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

      The KMS key ID for the customer S3 location when encrypting with an Amazon Web Services managed key.

      Returns:
      The KMS key ID for the customer S3 location when encrypting with an Amazon Web Services managed key.

    • toBuilder

      public S3Configuration.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<S3Configuration.Builder,S3Configuration>
      Returns:
      a builder for type T

    • builder

      public static S3Configuration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3Configuration.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.