Class S3FilesConfig

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

Setting controls how your function accesses data from an Amazon S3 file system.

See Also:

  • Method Details

    • directS3Read

      public final DirectS3Read directS3Read()

      Specifies if a function reads from the file system for the lowest latency, or through Amazon S3 Files feature "direct Amazon S3 bucket reads" for the highest throughput. Valid values:

      • AUTO (default) – Direct reads are active for functions you configure with 512 MB or more of memory.

      • ENABLED – Enforces all reads are directly from the Amazon S3 bucket, regardless of available memory (less than 512 MB).

      • DISABLED – Routes all reads through the file system, regardless of memory configuration.

      To use direct reads, you must grant the execution role the s3:GetObject and s3:GetObjectVersion permissions. If a direct read fails, Lambda automatically falls back to reading through the file system.

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

      Returns:
      Specifies if a function reads from the file system for the lowest latency, or through Amazon S3 Files feature "direct Amazon S3 bucket reads" for the highest throughput. Valid values:

      • AUTO (default) – Direct reads are active for functions you configure with 512 MB or more of memory.

      • ENABLED – Enforces all reads are directly from the Amazon S3 bucket, regardless of available memory (less than 512 MB).

      • DISABLED – Routes all reads through the file system, regardless of memory configuration.

      To use direct reads, you must grant the execution role the s3:GetObject and s3:GetObjectVersion permissions. If a direct read fails, Lambda automatically falls back to reading through the file system.

      See Also:

    • directS3ReadAsString

      public final String directS3ReadAsString()

      Specifies if a function reads from the file system for the lowest latency, or through Amazon S3 Files feature "direct Amazon S3 bucket reads" for the highest throughput. Valid values:

      • AUTO (default) – Direct reads are active for functions you configure with 512 MB or more of memory.

      • ENABLED – Enforces all reads are directly from the Amazon S3 bucket, regardless of available memory (less than 512 MB).

      • DISABLED – Routes all reads through the file system, regardless of memory configuration.

      To use direct reads, you must grant the execution role the s3:GetObject and s3:GetObjectVersion permissions. If a direct read fails, Lambda automatically falls back to reading through the file system.

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

      Returns:
      Specifies if a function reads from the file system for the lowest latency, or through Amazon S3 Files feature "direct Amazon S3 bucket reads" for the highest throughput. Valid values:

      • AUTO (default) – Direct reads are active for functions you configure with 512 MB or more of memory.

      • ENABLED – Enforces all reads are directly from the Amazon S3 bucket, regardless of available memory (less than 512 MB).

      • DISABLED – Routes all reads through the file system, regardless of memory configuration.

      To use direct reads, you must grant the execution role the s3:GetObject and s3:GetObjectVersion permissions. If a direct read fails, Lambda automatically falls back to reading through the file system.

      See Also:

    • toBuilder

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

    • builder

      public static S3FilesConfig.Builder builder()

    • serializableBuilderClass

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