Amazon Well-Architected Tool · JSON Structure

Well Architected Tool Create Workload Input Structure

Input for workload creation.

Type: object Properties: 18 Required: 5

ArchitectureBest PracticesCloud GovernanceWell-ArchitectedWorkloads

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

Properties

WorkloadName Description Environment AccountIds AwsRegions NonAwsRegions PillarPriorities ArchitecturalDesign ReviewOwner IndustryType Industry Lenses Notes ClientRequestToken Tags DiscoveryConfig Applications ProfileArns

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

JSON Structure

{
  "type": "object",
  "required": [
    "WorkloadName",
    "Description",
    "Environment",
    "Lenses",
    "ClientRequestToken"
  ],
  "name": "CreateWorkloadInput",
  "properties": {
    "WorkloadName": {
      "$ref": "#/components/schemas/WorkloadName"
    },
    "Description": {
      "$ref": "#/components/schemas/WorkloadDescription"
    },
    "Environment": {
      "$ref": "#/components/schemas/WorkloadEnvironment"
    },
    "AccountIds": {
      "$ref": "#/components/schemas/WorkloadAccountIds"
    },
    "AwsRegions": {
      "$ref": "#/components/schemas/WorkloadAwsRegions"
    },
    "NonAwsRegions": {
      "$ref": "#/components/schemas/WorkloadNonAwsRegions"
    },
    "PillarPriorities": {
      "$ref": "#/components/schemas/WorkloadPillarPriorities"
    },
    "ArchitecturalDesign": {
      "$ref": "#/components/schemas/WorkloadArchitecturalDesign"
    },
    "ReviewOwner": {
      "$ref": "#/components/schemas/WorkloadReviewOwner"
    },
    "IndustryType": {
      "$ref": "#/components/schemas/WorkloadIndustryType"
    },
    "Industry": {
      "$ref": "#/components/schemas/WorkloadIndustry"
    },
    "Lenses": {
      "$ref": "#/components/schemas/WorkloadLenses"
    },
    "Notes": {
      "$ref": "#/components/schemas/Notes"
    },
    "ClientRequestToken": {
      "$ref": "#/components/schemas/ClientRequestToken"
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "The tags to be associated with the workload."
        }
      ]
    },
    "DiscoveryConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkloadDiscoveryConfig"
        },
        {
          "description": "Well-Architected discovery configuration settings associated to the workload."
        }
      ]
    },
    "Applications": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkloadApplications"
        },
        {
          "description": "List of AppRegistry application ARNs associated to the workload."
        }
      ]
    },
    "ProfileArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkloadProfileArns"
        },
        {
          "description": "The list of profile ARNs associated with the workload."
        }
      ]
    }
  },
  "description": "Input for workload creation.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-well-architected-tool/refs/heads/main/json-structure/well-architected-tool-create-workload-input-structure.json"
}