Type Alias S3Config

Type declaration

• OptionalaccessKeyId?: undefined | string

  Deprecated

  Use the credentials object instead

• apiVersion: undefined | string

• base64Decoder: undefined | Decoder

• base64Encoder: undefined | Encoder

• bodyLengthChecker: undefined | BodyLengthCalculator

• bucketEndpoint: undefined | boolean

• cacheMiddleware: undefined | boolean

• credentialDefaultProvider: undefined | ((input: any) => AwsCredentialIdentityProvider)

• credentials: undefined | AwsCredentialIdentity | AwsCredentialIdentityProvider

• customUserAgent: undefined | string | UserAgent

• defaultUserAgentProvider: undefined | Provider<UserAgent>

• defaultsMode: undefined | DefaultsMode | Provider<DefaultsMode>

• disableHostPrefix: undefined | boolean

• disableMultiregionAccessPoints: undefined | (boolean & (boolean | Provider<boolean>))

• disableS3ExpressSessionAuth: undefined | boolean | Provider<boolean>

• endpoint: undefined | ((string | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>) & (string | Provider<string> | Endpoint | Provider<...> | EndpointV2 | Provider<...>))

• endpointProvider: undefined | ((params: EndpointParameters, context?: {
      logger?: Logger;
  }) => EndpointV2)

• eventStreamSerdeProvider: undefined | EventStreamSerdeProvider

• extensions: undefined | RuntimeExtension[]

• followRegionRedirects: undefined | boolean

• forcePathStyle: undefined | (boolean & (boolean | Provider<boolean>))

• getAwsChunkedEncodingStream: undefined | GetAwsChunkedEncodingStream<any>

• httpAuthSchemeProvider: undefined | S3HttpAuthSchemeProvider

• httpAuthSchemes: undefined | HttpAuthScheme[]

• logger: undefined | Logger

• maxAttempts: undefined | number | Provider<number>

• md5: undefined | ChecksumConstructor | HashConstructor

• profile: undefined | string

• region: undefined | string | Provider<string>

• requestChecksumCalculation: undefined | RequestChecksumCalculation | Provider<RequestChecksumCalculation>

• requestHandler: undefined | ((NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record<string, unknown> | RequestHandler<any, any, HttpHandlerOptions>) & HttpHandlerUserInput)

• responseChecksumValidation: undefined | ResponseChecksumValidation | Provider<ResponseChecksumValidation>

• retryMode: undefined | string | Provider<string>

• retryStrategy: undefined | RetryStrategy | RetryStrategyV2

• runtime: undefined | string

• s3ExpressIdentityProvider: undefined | S3ExpressIdentityProvider

• sdkStreamMixin: undefined | SdkStreamMixinInjector

• OptionalsecretAccessKey?: undefined | string

  Deprecated

  Use the credentials object instead

• serviceConfiguredEndpoint: undefined

• serviceId: undefined | string

• sha1: undefined | ChecksumConstructor | HashConstructor

• sha256: undefined | ChecksumConstructor | HashConstructor

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

• signerConstructor: undefined | (new (options: SignatureV4Init & SignatureV4CryptoInit) => RequestSigner)

• signingEscapePath: undefined | boolean

• signingRegion: undefined | string

• sigv4aSigningRegionSet: undefined | string[] | Provider<undefined | string[]>

• streamCollector: undefined | StreamCollector

• streamHasher: undefined | StreamHasher<Readable> | StreamHasher<Blob>

• systemClockOffset: undefined | number

• tls: undefined | boolean

• urlParser: undefined | UrlParser

• useAccelerateEndpoint: undefined | (boolean & (boolean | Provider<boolean>))

• useArnRegion: undefined | boolean | Provider<boolean>

• useDualstackEndpoint: undefined | boolean | Provider<boolean>

• useFipsEndpoint: undefined | boolean | Provider<boolean>

• useGlobalEndpoint: undefined | boolean | Provider<boolean>

• userAgentAppId: undefined | string | Provider<undefined | string>

• utf8Decoder: undefined | Decoder

• utf8Encoder: undefined | Encoder