@terascope/file-asset-apis / s3/createS3Client
s3/createS3Client
Interfaces
| Interface | Description |
|---|---|
| S3ClientConfig | - |
| S3ClientCredentials | - |
Functions
createCredentialsObject()
createCredentialsObject(
config):S3ClientCredentials
Defined in: s3/createS3Client.ts:135
Given an S3 client configuration, create a credentials object containing accessKeyId and secretAccessKey. S3Client V3 expects accessKeyId and secretAccessKey to be within a credentials object.
Parameters
| Parameter | Type | Description |
|---|---|---|
config | S3ClientConfig | S3 client configuration object |
Returns
createHttpOptions()
createHttpOptions(
config):Promise<AgentOptions>
Defined in: s3/createS3Client.ts:81
Given the S3 client configuration, return httpOptions containig CA certs.
Parameters
| Parameter | Type | Description |
|---|---|---|
config | S3ClientConfig | S3 client configuration object |
Returns
Promise<AgentOptions>
Options used to make HttpsAgent
createRequestHandlerOptions()
createRequestHandlerOptions(
httpOptions):NodeHttpHandlerOptions
Defined in: s3/createS3Client.ts:122
Given HttpAgentOptions, create NodeHttpHandlerOptions
Parameters
| Parameter | Type | Description |
|---|---|---|
httpOptions | AgentOptions |
Returns
NodeHttpHandlerOptions
createS3Client()
createS3Client(
config,logger):Promise<S3Client>
Defined in: s3/createS3Client.ts:27
Parameters
| Parameter | Type |
|---|---|
config | S3ClientConfig |
logger | Logger |
Returns
Promise<S3Client>
genFinalS3ClientConfig()
genFinalS3ClientConfig(
config):Promise<S3ClientConfig>
Defined in: s3/createS3Client.ts:51
Given an S3ClientConfig object, modify to make compatible with S3 Client V3
Parameters
| Parameter | Type | Description |
|---|---|---|
config | S3ClientConfig | Starting S3 client configuration object |
Returns
Promise<S3ClientConfig>
Final S3 client configuration object