AliasConfiguration

Provides configuration information about a Lambda function alias.

APIs.ioEngineeringPlatform

Properties

Name Type Description
AliasArn object
Name object
FunctionVersion object
Description object
RoutingConfig object
RevisionId object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-aliasconfiguration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AliasConfiguration",
  "title": "AliasConfiguration",
  "type": "object",
  "properties": {
    "AliasArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FunctionArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the alias."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Alias"
        },
        {
          "description": "The name of the alias."
        }
      ]
    },
    "FunctionVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "The function version that the alias invokes."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "A description of the alias."
        }
      ]
    },
    "RoutingConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AliasRoutingConfiguration"
        },
        {
          "description": "The <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html\">routing configuration</a> of the alias."
        }
      ]
    },
    "RevisionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "A unique identifier that changes when you update the alias."
        }
      ]
    }
  },
  "description": "Provides configuration information about a Lambda function <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html\">alias</a>."
}