Amazon CodeDeploy · JSON Structure

Amazon Codedeploy Create Deployment Request Structure

CreateDeploymentRequest schema from Amazon CodeDeploy

Type: object Properties: 5 Required: 2

AmazonDeploymentDevOpsCI/CDRelease ManagementBlue/Green Deployment

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

Properties

applicationName deploymentGroupName revision description autoRollbackConfiguration

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/json-structure/amazon-codedeploy-create-deployment-request-structure.json",
  "name": "CreateDeploymentRequest",
  "description": "CreateDeploymentRequest schema from Amazon CodeDeploy",
  "type": "object",
  "properties": {
    "applicationName": {
      "type": "string",
      "description": "The name of the application."
    },
    "deploymentGroupName": {
      "type": "string",
      "description": "The name of the deployment group."
    },
    "revision": {
      "type": "object",
      "properties": {
        "revisionType": {
          "type": "string",
          "enum": [
            "S3",
            "GitHub",
            "String",
            "AppSpecContent"
          ]
        },
        "s3Location": {
          "type": "object",
          "properties": {
            "bucket": {
              "type": "string"
            },
            "key": {
              "type": "string"
            },
            "bundleType": {
              "type": "string",
              "enum": [
                "tar",
                "tgz",
                "zip",
                "YAML",
                "JSON"
              ]
            }
          }
        },
        "gitHubLocation": {
          "type": "object",
          "properties": {
            "repository": {
              "type": "string"
            },
            "commitId": {
              "type": "string"
            }
          }
        }
      }
    },
    "description": {
      "type": "string",
      "description": "A comment about the deployment."
    },
    "autoRollbackConfiguration": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "events": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "DEPLOYMENT_FAILURE",
              "DEPLOYMENT_STOP_ON_ALARM",
              "DEPLOYMENT_STOP_ON_REQUEST"
            ]
          }
        }
      }
    }
  },
  "required": [
    "applicationName",
    "deploymentGroupName"
  ]
}