@resistdesign/voltra
    Preparing search index...

    Type Alias AbridgedS3ClientConfig

    S3 client configuration subset for generated docs.

    type AbridgedS3ClientConfig = {
        apiVersion?: string;
        base64Decoder?: string;
        base64Encoder?: string;
        bodyLengthChecker?: string;
        credentialDefaultProvider?: string;
        credentials?: string | Credentials;
        customUserAgent?: string;
        defaultsMode?:
            | "standard"
            | "in-region"
            | "cross-region"
            | "mobile"
            | "auto"
            | "legacy";
        defaultUserAgentProvider?: string;
        disableHostPrefix?: string
        | false
        | true;
        disableMultiregionAccessPoints?: string | false | true;
        disableS3ExpressSessionAuth?: string | false | true;
        endpoint?: string | Endpoint;
        endpointProvider?: string;
        extensions?: string;
        followRegionRedirects?: string | false | true;
        forcePathStyle?: string | false | true;
        getAwsChunkedEncodingStream?: string;
        logger?: string | Logger;
        maxAttempts?: string;
        md5?: string;
        region?: string;
        requestHandler?: string;
        retryMode?: string;
        retryStrategy?: string | RetryStrategy;
        runtime?: string;
        s3ExpressIdentityProvider?: string;
        sdkStreamMixin?: string;
        serviceId?: string;
        sha1?: string;
        sha256?: string;
        signer?: string | Signer;
        signerConstructor?: string;
        signingEscapePath?: string | false | true;
        signingRegion?: string;
        streamCollector?: string;
        streamHasher?: string;
        systemClockOffset?: string;
        tls?: string | false | true;
        urlParser?: string;
        useAccelerateEndpoint?: string | false | true;
        useArnRegion?: string | false | true;
        useDualstackEndpoint?: string | false | true;
        useFipsEndpoint?: string | false | true;
        useGlobalEndpoint?: string | false | true;
        utf8Decoder?: string;
        utf8Encoder?: string;
    }
    Index

    Properties

    apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? credentialDefaultProvider? credentials? customUserAgent? defaultsMode? defaultUserAgentProvider? disableHostPrefix? disableMultiregionAccessPoints? disableS3ExpressSessionAuth? endpoint? endpointProvider? extensions? followRegionRedirects? forcePathStyle? getAwsChunkedEncodingStream? logger? maxAttempts? md5? region? requestHandler? retryMode? retryStrategy? runtime? s3ExpressIdentityProvider? sdkStreamMixin? serviceId? sha1? sha256? signer? signerConstructor? signingEscapePath? signingRegion? streamCollector? streamHasher? systemClockOffset? tls? urlParser? useAccelerateEndpoint? useArnRegion? useDualstackEndpoint? useFipsEndpoint? useGlobalEndpoint? utf8Decoder? utf8Encoder?

    Properties

    apiVersion?: string

    API version override for the S3 client.

    base64Decoder?: string

    Base64 decoder override.

    base64Encoder?: string

    Base64 encoder override.

    bodyLengthChecker?: string

    Body length checker override.

    credentialDefaultProvider?: string

    Credential provider override.

    credentials?: string | Credentials

    Credentials override.

    customUserAgent?: string

    Custom user agent string.

    defaultsMode?:
        | "standard"
        | "in-region"
        | "cross-region"
        | "mobile"
        | "auto"
        | "legacy"

    Defaults mode selector for AWS SDK config.

    defaultUserAgentProvider?: string

    Default user agent provider override.

    disableHostPrefix?: string | false | true

    Disable host prefix injection.

    disableMultiregionAccessPoints?: string | false | true

    Disable multiregion access points.

    disableS3ExpressSessionAuth?: string | false | true

    Disable S3 Express session auth.

    endpoint?: string | Endpoint

    Explicit endpoint override.

    endpointProvider?: string

    Endpoint provider override.

    extensions?: string

    Extensions applied to the client.

    followRegionRedirects?: string | false | true

    Follow region redirects.

    forcePathStyle?: string | false | true

    Force path-style addressing.

    getAwsChunkedEncodingStream?: string

    AWS chunked encoding stream override.

    logger?: string | Logger

    Logger configuration or identifier.

    maxAttempts?: string

    Maximum retry attempts.

    md5?: string

    MD5 implementation override.

    region?: string

    AWS region identifier.

    requestHandler?: string

    Custom request handler override.

    retryMode?: string

    Retry mode identifier.

    retryStrategy?: string | RetryStrategy

    Retry strategy override.

    runtime?: string

    Runtime identifier override.

    s3ExpressIdentityProvider?: string

    S3 Express identity provider override.

    sdkStreamMixin?: string

    SDK stream mixin override.

    serviceId?: string

    Service id override.

    sha1?: string

    SHA1 implementation override.

    sha256?: string

    Hash implementation identifier.

    signer?: string | Signer

    Signer override.

    signerConstructor?: string

    Signer constructor override.

    signingEscapePath?: string | false | true

    Signing path escape toggle.

    signingRegion?: string

    Signing region override.

    streamCollector?: string

    Stream collector override.

    streamHasher?: string

    Stream hasher override.

    systemClockOffset?: string

    System clock offset override.

    tls?: string | false | true

    TLS usage override.

    urlParser?: string

    URL parser override.

    useAccelerateEndpoint?: string | false | true

    Use accelerate endpoint.

    useArnRegion?: string | false | true

    Use ARN region in requests.

    useDualstackEndpoint?: string | false | true

    Enable dualstack endpoints.

    useFipsEndpoint?: string | false | true

    Enable FIPS endpoints.

    useGlobalEndpoint?: string | false | true

    Use global endpoint.

    utf8Decoder?: string

    UTF-8 decoder override.

    utf8Encoder?: string

    UTF-8 encoder override.

    Settings

    Member Visibility

    On This Page

    Properties