⚠️ DEPRECATED: Typed connector configuration models are deprecated and will be removed in v1.1.0. Pass configuration as a plain dict with a required 'destinationType' key instead..
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
access_key_id |
Optional[str] | ➖ | The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here. | A012345678910EXAMPLE |
destination_type |
models.DestinationS3S3 | ✔️ | N/A | |
file_name_pattern |
Optional[str] | ➖ | Pattern to match file names in the bucket directory. Read more here |
Example 1: {date} Example 2: {date:yyyy_MM} Example 3: {timestamp} Example 4: {part_number} Example 5: {sync_id} |
format_ |
models.DestinationS3OutputFormat | ✔️ | Format of the data output. See here for more details | |
role_arn |
Optional[str] | ➖ | The ARN of the AWS role to assume. Only usable in Airbyte Cloud. | arn:aws:iam::123456789:role/ExternalIdIsYourWorkspaceId |
s3_bucket_name |
str | ✔️ | The name of the S3 bucket. Read more here. | airbyte_sync |
s3_bucket_path |
str | ✔️ | Directory under the S3 bucket where data will be written. Read more here | data_sync/test |
s3_bucket_region |
Optional[models.DestinationS3S3BucketRegion] | ➖ | The region of the S3 bucket. See here for all region codes. | us-east-1 |
s3_endpoint |
Optional[str] | ➖ | Your S3 endpoint url. Read more here | http://localhost:9000 |
s3_path_format |
Optional[str] | ➖ | Format string on how data will be organized inside the bucket directory. Read more here | ${NAMESPACE}/${STREAM_NAME}/${YEAR}${MONTH}${DAY}${EPOCH} |
secret_access_key |
Optional[str] | ➖ | The corresponding secret to the access key ID. Read more here | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY |