ts-lambda-api - v2.5.3
    Preparing search index...

    Interface S3InputConfig

    All endpoint parameters with built-in bindings of AWS::S3::*

    interface S3InputConfig {
        bucketEndpoint?: boolean;
        disableMultiregionAccessPoints?: boolean;
        expectContinueHeader?: number | boolean;
        followRegionRedirects?: boolean;
        forcePathStyle?: boolean;
        s3ExpressIdentityProvider?: S3ExpressIdentityProvider;
        useAccelerateEndpoint?: boolean;
    }
    Index

    Properties

    bucketEndpoint? disableMultiregionAccessPoints? expectContinueHeader? followRegionRedirects? forcePathStyle? s3ExpressIdentityProvider? useAccelerateEndpoint?

    Properties

    bucketEndpoint?: boolean

    Whether to use the bucket name as the endpoint for this client.

    disableMultiregionAccessPoints?: boolean

    Whether multi-region access points (MRAP) should be disabled.

    expectContinueHeader?: number | boolean

    This field configures the SDK's behavior around setting the expect: 100-continue header.

    Default: 2_097_152 (2 MB)

    When given as a boolean - always send or omit the header. When given as a number - minimum byte threshold of the payload before setting the header. Unmeasurable payload sizes (streams) will set the header too.

    The expect: 100-continue header is used to allow the server a chance to validate the PUT request headers before the client begins to send the object payload. This avoids wasteful data transmission for a request that is rejected.

    However, there is a trade-off where the request will take longer to complete.

    followRegionRedirects?: boolean

    This feature was previously called the S3 Global Client. This can result in additional latency as failed requests are retried with a corrected region when receiving a permanent redirect error with status 301. This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.

    forcePathStyle?: boolean

    Whether to force path style URLs for S3 objects (e.g., https://s3.amazonaws.com// instead of https://.s3.amazonaws.com/

    s3ExpressIdentityProvider?: S3ExpressIdentityProvider

    Identity provider for an S3 feature.

    useAccelerateEndpoint?: boolean

    Whether to use the S3 Transfer Acceleration endpoint by default

    Settings

    Member Visibility

    On This Page

    Properties