Class OutputS3Configuration

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

Contains the Amazon S3 location, encryption settings, and output types for a bulk operation. The S3Bucket and OutputType fields are required.

See Also:

  • Method Details

    • s3BucketOwner

      public final String s3BucketOwner()

      The Amazon Web Services account ID of the output bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.

      S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.

      Returns:
      The Amazon Web Services account ID of the output bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.

      S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.

    • s3Bucket

      public final String s3Bucket()

      The name of the Amazon S3 bucket where DynamoDB writes output records.

      Returns:
      The name of the Amazon S3 bucket where DynamoDB writes output records.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      An optional key prefix under which DynamoDB writes the output records.

      Returns:
      An optional key prefix under which DynamoDB writes the output records.

    • s3SseAlgorithm

      public final S3SseAlgorithm s3SseAlgorithm()

      The server-side encryption algorithm for the output objects. Valid values are AES256 and KMS. If you don't specify a value, Amazon S3 applies the destination bucket's default encryption settings.

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

      Returns:
      The server-side encryption algorithm for the output objects. Valid values are AES256 and KMS. If you don't specify a value, Amazon S3 applies the destination bucket's default encryption settings.
      See Also:

    • s3SseAlgorithmAsString

      public final String s3SseAlgorithmAsString()

      The server-side encryption algorithm for the output objects. Valid values are AES256 and KMS. If you don't specify a value, Amazon S3 applies the destination bucket's default encryption settings.

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

      Returns:
      The server-side encryption algorithm for the output objects. Valid values are AES256 and KMS. If you don't specify a value, Amazon S3 applies the destination bucket's default encryption settings.
      See Also:

    • s3SseKmsKeyId

      public final String s3SseKmsKeyId()

      The identifier of the KMS key that encrypts the output objects. Specify this value when S3SseAlgorithm is KMS. Don't specify it when the algorithm is AES256.

      Returns:
      The identifier of the KMS key that encrypts the output objects. Specify this value when S3SseAlgorithm is KMS. Don't specify it when the algorithm is AES256.

    • outputType

      public final List<OutputTypeEnum> outputType()

      The following values describe the types of output that DynamoDB writes for individual input items. Include one or both values.

      ERROR

      Reports input records or input objects that DynamoDB couldn't process. This includes malformed input and item validation failures, such as a missing or incorrectly typed primary key attribute or an item that exceeds a DynamoDB limit.

      CONDITION_CHECK_FAILURE

      Reports the attempted item and, when present, the existing item for a write whose condition expression evaluates to false.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputType() method.

      Returns:
      The following values describe the types of output that DynamoDB writes for individual input items. Include one or both values.

      ERROR

      Reports input records or input objects that DynamoDB couldn't process. This includes malformed input and item validation failures, such as a missing or incorrectly typed primary key attribute or an item that exceeds a DynamoDB limit.

      CONDITION_CHECK_FAILURE

      Reports the attempted item and, when present, the existing item for a write whose condition expression evaluates to false.

    • hasOutputType

      public final boolean hasOutputType()
      For responses, this returns true if the service returned a value for the OutputType property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • outputTypeAsStrings

      public final List<String> outputTypeAsStrings()

      The following values describe the types of output that DynamoDB writes for individual input items. Include one or both values.

      ERROR

      Reports input records or input objects that DynamoDB couldn't process. This includes malformed input and item validation failures, such as a missing or incorrectly typed primary key attribute or an item that exceeds a DynamoDB limit.

      CONDITION_CHECK_FAILURE

      Reports the attempted item and, when present, the existing item for a write whose condition expression evaluates to false.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputType() method.

      Returns:
      The following values describe the types of output that DynamoDB writes for individual input items. Include one or both values.

      ERROR

      Reports input records or input objects that DynamoDB couldn't process. This includes malformed input and item validation failures, such as a missing or incorrectly typed primary key attribute or an item that exceeds a DynamoDB limit.

      CONDITION_CHECK_FAILURE

      Reports the attempted item and, when present, the existing item for a write whose condition expression evaluates to false.

    • toBuilder

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

    • builder

      public static OutputS3Configuration.Builder builder()

    • serializableBuilderClass

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