Amazon Elastic Load Balancing · JSON Structure

Amazon Elastic Load Balancing Action Structure

Describes an action for a listener or rule

Type: object Properties: 5
Amazon Web ServicesHigh AvailabilityLoad BalancingNetworkingScalability

Action is a JSON Structure definition published by Amazon Elastic Load Balancing, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type targetGroupArn order redirectConfig fixedResponseConfig

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-elastic-load-balancing/refs/heads/main/json-structure/amazon-elastic-load-balancing-action-structure.json",
  "name": "Action",
  "description": "Describes an action for a listener or rule",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of action",
      "enum": [
        "forward",
        "authenticate-oidc",
        "authenticate-cognito",
        "redirect",
        "fixed-response"
      ]
    },
    "targetGroupArn": {
      "type": "string",
      "description": "The ARN of the target group for forward actions"
    },
    "order": {
      "type": "int32",
      "description": "The order for the action"
    },
    "redirectConfig": {
      "type": "object",
      "description": "Configuration for redirect actions",
      "properties": {
        "protocol": {
          "type": "string",
          "description": "The protocol"
        },
        "port": {
          "type": "string",
          "description": "The port"
        },
        "host": {
          "type": "string",
          "description": "The hostname"
        },
        "path": {
          "type": "string",
          "description": "The absolute path"
        },
        "query": {
          "type": "string",
          "description": "The query parameters"
        },
        "statusCode": {
          "type": "string",
          "description": "The HTTP redirect code",
          "enum": [
            "HTTP_301",
            "HTTP_302"
          ]
        }
      }
    },
    "fixedResponseConfig": {
      "type": "object",
      "description": "Configuration for fixed-response actions",
      "properties": {
        "messageBody": {
          "type": "string",
          "description": "The message body"
        },
        "statusCode": {
          "type": "string",
          "description": "The HTTP response code"
        },
        "contentType": {
          "type": "string",
          "description": "The content type"
        }
      }
    }
  }
}