Amazon CodeBuild · JSON Structure

Amazon Codebuild S3 Logs Config Structure

Information about S3 logs for a build project.

Type: object Properties: 4 Required: 1
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

S3LogsConfig is a JSON Structure definition published by Amazon CodeBuild, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status location encryptionDisabled bucketOwnerAccess

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-s3-logs-config-structure.json",
  "name": "S3LogsConfig",
  "description": " Information about S3 logs for a build project. ",
  "type": "object",
  "properties": {
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LogsConfigStatusType"
        },
        {
          "description": "<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>"
        }
      ]
    },
    "location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. "
        }
      ]
    },
    "encryptionDisabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperBoolean"
        },
        {
          "description": " Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. "
        }
      ]
    },
    "bucketOwnerAccess": {
      "$ref": "#/components/schemas/BucketOwnerAccess"
    }
  },
  "required": [
    "status"
  ]
}