Amazon Proton · JSON Structure

Amazon Proton Service Sync Config Structure

Detailed data of the service sync configuration.

Type: object Properties: 5 Required: 5
DevOpsInfrastructure as CodePlatform EngineeringServerlessTemplatesSelf-ServiceCI/CD

ServiceSyncConfig is a JSON Structure definition published by Amazon Proton, describing 5 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

branch filePath repositoryName repositoryProvider serviceName

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-proton/refs/heads/main/json-structure/amazon-proton-service-sync-config-structure.json",
  "name": "ServiceSyncConfig",
  "description": "Detailed data of the service sync configuration.",
  "type": "object",
  "properties": {
    "branch": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GitBranchName"
        },
        {
          "description": "The name of the code repository branch that holds the service code Proton will sync with."
        }
      ]
    },
    "filePath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OpsFilePath"
        },
        {
          "description": "The file path to the service sync configuration file."
        }
      ]
    },
    "repositoryName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RepositoryName"
        },
        {
          "description": "The name of the code repository that holds the service code Proton will sync with."
        }
      ]
    },
    "repositoryProvider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RepositoryProvider"
        },
        {
          "description": "The name of the repository provider that holds the repository Proton will sync with."
        }
      ]
    },
    "serviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the service that the service instance is added to."
        }
      ]
    }
  },
  "required": [
    "branch",
    "filePath",
    "repositoryName",
    "repositoryProvider",
    "serviceName"
  ]
}