View a markdown version of this page

StreamBucketConfig - Amazon OpenSearch Serverless

StreamBucketConfig

The configuration for an Amazon S3 bucket that an ingestion stream ingests data from.

Contents

bucket

The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 2048.

Pattern: (arn:[a-z0-9\-]+:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]|[a-z0-9][a-z0-9.-]{1,61}[a-z0-9])

Required: Yes

bucketOwnerAccountId

The AWS account ID that owns the Amazon S3 bucket. If omitted, the bucket is assumed to be owned by the same account as the one in sqsArn. For cross-account buckets, you must set this value to the account ID of the bucket owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

initialScan

Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED, only new objects are ingested.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: