S3Configuration is a datatype for configuration for S3 archiving (e.g., bucket name and region). It implements the interface datatype, ArchivingConfiguration.

This datatype is used by the s3ArchivingConfiguration parameter of the Repository, which is used by several mutation and query fields.

Table: S3Configuration

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 27, 2025
bucketstringyes Short-TermS3 bucket name for storing archived data (e.g., acme-bucket).
disabledboolean  Short-TermWhether the archiving has been disabled.
formatS3ArchivingFormat  Short-TermThe format in which to store the archived data on Amazon Web Services S3. See S3ArchivingFormat.
regionstringyes Short-TermThe region to which the S3 bucket belongs (e.g., eu-central-1).
roleArnstring  Short-TermThe ARN of the AWS Role that is assumed when writing to S3.
startFromdatetime  Short-TermStarting date and time from which to archive logs.
tagOrderInName[string]yes Short-TermArray of names of tag fields to use in that order in the output file names.