Amazon CodeBuild · JSON Structure

Amazon Codebuild Cloud Watch Logs Config Structure

Information about CloudWatch Logs for a build project.

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

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

Properties

status groupName streamName

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-cloud-watch-logs-config-structure.json",
  "name": "CloudWatchLogsConfig",
  "description": " Information about CloudWatch Logs for a build project. ",
  "type": "object",
  "properties": {
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LogsConfigStatusType"
        },
        {
          "description": "<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>"
        }
      ]
    },
    "groupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The group name of the logs in CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. "
        }
      ]
    },
    "streamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The prefix of the stream name of the CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a>. "
        }
      ]
    }
  },
  "required": [
    "status"
  ]
}