IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface S3ClientResolvedConfig

    The resolved configuration interface of S3Client class. This is resolved and normalized from the constructor configuration interface.

    interface S3ClientResolvedConfig {
        credentials: (
            arg?: Record<string, any> & {},
        ) => Promise<AwsCredentialIdentity> & AwsSdkSigV4Memoized;
        signer: (authScheme?: AuthScheme) => Promise<RequestSigner>;
        systemClockOffset: number;
        requestChecksumCalculation: Provider<RequestChecksumCalculation>;
        responseChecksumValidation: Provider<ResponseChecksumValidation>;
        requestStreamBufferSize: number;
        forcePathStyle:
            | boolean
            | false & Provider<boolean | undefined>
            | true & Provider<boolean | undefined>;
        useAccelerateEndpoint:
            | boolean
            | false & Provider<boolean | undefined>
            | true & Provider<boolean | undefined>;
        disableMultiregionAccessPoints:
            | boolean
            | false & Provider<boolean | undefined>
            | true & Provider<boolean | undefined>;
        followRegionRedirects: boolean;
        s3ExpressIdentityProvider: S3ExpressIdentityProvider;
        bucketEndpoint: boolean;
        expectContinueHeader: number | boolean;
        customUserAgent?: UserAgent;
        userAgentAppId: Provider<string | undefined>;
        sha256: ChecksumConstructor | HashConstructor;
        urlParser: UrlParser;
        bodyLengthChecker: BodyLengthCalculator;
        streamCollector: StreamCollector;
        base64Decoder: Decoder;
        base64Encoder: Encoder;
        utf8Decoder: Decoder;
        utf8Encoder: Encoder;
        runtime: string;
        disableHostPrefix: boolean;
        profile: string;
        defaultUserAgentProvider: Provider<UserAgent>;
        streamHasher: StreamHasher<Readable> | StreamHasher<Blob>;
        md5: ChecksumConstructor | HashConstructor;
        sha1: ChecksumConstructor | HashConstructor;
        getAwsChunkedEncodingStream: GetAwsChunkedEncodingStream;
        credentialDefaultProvider: (input: any) => AwsCredentialIdentityProvider;
        retryMode: string | Provider<string>;
        extensions: RuntimeExtension[];
        eventStreamSerdeProvider: EventStreamSerdeProvider;
        defaultsMode: DefaultsMode | Provider<DefaultsMode>;
        signingEscapePath: boolean;
        useArnRegion: (boolean | Provider<boolean | undefined>) & (
            boolean
            | Provider<boolean | undefined>
            | undefined
        );
        sdkStreamMixin: SdkStreamMixinInjector;
        authSchemePreference: Provider<string[]>;
        httpAuthSchemes: HttpAuthScheme[];
        httpAuthSchemeProvider: S3HttpAuthSchemeProvider;
        clientContextParams?: {
            disableS3ExpressSessionAuth?: boolean | Provider<boolean | undefined>;
        };
        useGlobalEndpoint?: boolean
        | Provider<boolean | undefined>;
        disableS3ExpressSessionAuth?: boolean | Provider<boolean | undefined>;
        defaultSigningName: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    credentials: (arg?: Record<string, any> & {}) => Promise<AwsCredentialIdentity> & AwsSdkSigV4Memoized

    Resolved value for input config AwsSdkSigV4AuthInputConfig.credentials This provider MAY memoize the loaded credentials for certain period.

    signer: (authScheme?: AuthScheme) => Promise<RequestSigner>

    Resolved value for input config AwsSdkSigV4AuthInputConfig.signer

    systemClockOffset: number

    Resolved value for input config AwsSdkSigV4AuthInputConfig.systemClockOffset

    requestChecksumCalculation: Provider<RequestChecksumCalculation>
    responseChecksumValidation: Provider<ResponseChecksumValidation>
    requestStreamBufferSize: number
    forcePathStyle:
        | boolean
        | false & Provider<boolean | undefined>
        | true & Provider<boolean | undefined>
    useAccelerateEndpoint:
        | boolean
        | false & Provider<boolean | undefined>
        | true & Provider<boolean | undefined>
    disableMultiregionAccessPoints:
        | boolean
        | false & Provider<boolean | undefined>
        | true & Provider<boolean | undefined>
    followRegionRedirects: boolean
    s3ExpressIdentityProvider: S3ExpressIdentityProvider
    bucketEndpoint: boolean
    expectContinueHeader: number | boolean
    customUserAgent?: UserAgent

    The custom user agent header that would be appended to default one

    userAgentAppId: Provider<string | undefined>

    Resolved value for input config {config.userAgentAppId}

    sha256: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

    urlParser: UrlParser

    The function that will be used to convert strings into HTTP endpoints.

    bodyLengthChecker: BodyLengthCalculator

    A function that can calculate the length of a request body.

    streamCollector: StreamCollector

    A function that converts a stream into an array of bytes.

    base64Decoder: Decoder

    The function that will be used to convert a base64-encoded string to a byte array.

    base64Encoder: Encoder

    The function that will be used to convert binary data to a base64-encoded string.

    utf8Decoder: Decoder

    The function that will be used to convert a UTF8-encoded string to a byte array.

    utf8Encoder: Encoder

    The function that will be used to convert binary data to a UTF-8 encoded string.

    runtime: string

    The runtime environment.

    disableHostPrefix: boolean

    Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

    profile: string

    Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

    When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

    For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

    defaultUserAgentProvider: Provider<UserAgent>

    The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

    streamHasher: StreamHasher<Readable> | StreamHasher<Blob>

    A function that, given a hash constructor and a stream, calculates the hash of the streamed value.

    md5: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the __Checksum interface that computes MD5 hashes.

    sha1: ChecksumConstructor | HashConstructor

    A constructor for a class implementing the __Checksum interface that computes SHA1 hashes.

    getAwsChunkedEncodingStream: GetAwsChunkedEncodingStream

    A function that returns Readable Stream which follows aws-chunked encoding stream.

    credentialDefaultProvider: (input: any) => AwsCredentialIdentityProvider

    Default credentials provider; Not available in browser runtime.

    retryMode: string | Provider<string>

    Specifies which retry algorithm to use.

    extensions: RuntimeExtension[]

    Optional extensions

    eventStreamSerdeProvider: EventStreamSerdeProvider

    The function that provides necessary utilities for generating and parsing event stream

    defaultsMode: DefaultsMode | Provider<DefaultsMode>

    The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

    signingEscapePath: boolean

    Whether to escape request path when signing the request.

    useArnRegion: (boolean | Provider<boolean | undefined>) & (
        boolean
        | Provider<boolean | undefined>
        | undefined
    )

    Whether to override the request region with the region inferred from requested resource's ARN. Defaults to undefined.

    sdkStreamMixin: SdkStreamMixinInjector

    The internal function that inject utilities to runtime-specific stream to help users consume the data

    authSchemePreference: Provider<string[]>

    A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

    httpAuthSchemes: HttpAuthScheme[]

    Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

    httpAuthSchemeProvider: S3HttpAuthSchemeProvider

    Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

    clientContextParams?: {
        disableS3ExpressSessionAuth?: boolean | Provider<boolean | undefined>;
    }
    useGlobalEndpoint?: boolean | Provider<boolean | undefined>
    disableS3ExpressSessionAuth?: boolean | Provider<boolean | undefined>
    defaultSigningName: string