AWS App Runner · JSON Structure

App Runner Source Configuration Structure

SourceConfiguration schema from AWS App Runner

Type: object Properties: 4
CI/CDContainersDeploymentMicroservicesServerless

SourceConfiguration is a JSON Structure definition published by AWS App Runner, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CodeRepository ImageRepository AutoDeploymentsEnabled AuthenticationConfiguration

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "CodeRepository": {
      "type": "object",
      "properties": {
        "RepositoryUrl": {
          "type": "string"
        },
        "SourceCodeVersion": {
          "type": "object",
          "properties": {
            "Type": {
              "type": "string",
              "enum": [
                "BRANCH"
              ]
            },
            "Value": {
              "type": "string"
            }
          }
        },
        "CodeConfiguration": {
          "type": "object",
          "properties": {
            "ConfigurationSource": {
              "type": "string",
              "enum": [
                "REPOSITORY",
                "API"
              ]
            },
            "CodeConfigurationValues": {
              "type": "object",
              "properties": {
                "Runtime": {
                  "type": "string",
                  "enum": [
                    "PYTHON_3",
                    "NODEJS_12",
                    "NODEJS_14",
                    "NODEJS_16",
                    "NODEJS_18",
                    "CORRETTO_8",
                    "CORRETTO_11",
                    "GO_1",
                    "DOTNET_6",
                    "PHP_81",
                    "RUBY_31"
                  ]
                },
                "BuildCommand": {
                  "type": "string"
                },
                "StartCommand": {
                  "type": "string"
                },
                "Port": {
                  "type": "string"
                },
                "RuntimeEnvironmentVariables": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                },
                "RuntimeEnvironmentSecrets": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "SourceDirectory": {
          "type": "string"
        }
      }
    },
    "ImageRepository": {
      "type": "object",
      "properties": {
        "ImageIdentifier": {
          "type": "string"
        },
        "ImageConfiguration": {
          "type": "object",
          "properties": {
            "RuntimeEnvironmentVariables": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "RuntimeEnvironmentSecrets": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "StartCommand": {
              "type": "string"
            },
            "Port": {
              "type": "string"
            }
          }
        },
        "ImageRepositoryType": {
          "type": "string",
          "enum": [
            "ECR",
            "ECR_PUBLIC"
          ]
        }
      }
    },
    "AutoDeploymentsEnabled": {
      "type": "boolean"
    },
    "AuthenticationConfiguration": {
      "type": "object",
      "properties": {
        "ConnectionArn": {
          "type": "string"
        },
        "AccessRoleArn": {
          "type": "string"
        }
      }
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-runner/refs/heads/main/json-structure/app-runner-source-configuration-structure.json",
  "name": "SourceConfiguration",
  "description": "SourceConfiguration schema from AWS App Runner"
}