Class AnalysisLogExportS3OutputConfiguration

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

Contains output information for an analysis log export with an S3 output type.

The exported logs are written under the bucket and key prefix that you specify. The path includes the collaboration ID, the protected query ID, and the analysis log export ID. Because the path includes the export ID, exporting the same query more than once doesn't overwrite the logs from an earlier export.

The exported logs are encrypted using the default encryption configuration of the destination bucket. Clean Rooms doesn't accept a KMS key for log export. To encrypt the exported logs with a customer managed key, configure the bucket's default encryption to use that key before you export.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.

      Returns:
      The S3 bucket that the exported analysis logs are written to. The bucket must be in the same Amazon Web Services Region as the collaboration.

    • keyPrefix

      public final String keyPrefix()

      The S3 key prefix under which the exported analysis logs are written.

      Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.

      Returns:
      The S3 key prefix under which the exported analysis logs are written.

      Only one export can be in progress at a time for a given query and destination. To export the same query twice at once, use a different key prefix for the second export.

    • toBuilder

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

    • builder

      public static AnalysisLogExportS3OutputConfiguration.Builder builder()

    • serializableBuilderClass

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