ALIYUN::ESA::EdgeContainerApp - Resource Orchestration Service

Use the ALIYUN::ESA::EdgeContainerApp resource type to create an edge container application.

Syntax

{
  "Type": "ALIYUN::ESA::EdgeContainerApp",
  "Properties": {
    "EdgeContainerAppName": String,
    "ServicePort": Integer,
    "TargetPort": Integer,
    "HealthCheckFailTimes": Integer,
    "HealthCheckInterval": Integer,
    "HealthCheckUri": String,
    "HealthCheckHost": String,
    "HealthCheckTimeout": Integer,
    "HealthCheckSuccTimes": Integer,
    "HealthCheckMethod": String,
    "HealthCheckPort": Integer,
    "HealthCheckHttpCode": String,
    "HealthCheckType": String,
    "Remarks": String
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraints
EdgeContainerAppName	String	Yes	No	The application name.	The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length.
ServicePort	Integer	Yes	No	The service port number.	The value must be in the range of 1 to 65535.
TargetPort	Integer	Yes	No	The backend port.	The service port of the application. The value must be in the range of 1 to 65535.
HealthCheckFailTimes	Integer	No	No	The number of consecutive failed health checks.	The number of consecutive failed health checks that must occur before a healthy application is considered unhealthy. Valid values: 1 to 10. Default value: 5.
HealthCheckInterval	Integer	No	No	The interval between health checks.	Valid values: 1 to 50. Default value: 5. Unit: seconds.
HealthCheckUri	String	No	No	The URI for health checks.	The value must be 1 to 80 characters in length. Default value: /.
HealthCheckHost	String	No	No	The domain name for health checks.	This parameter is empty by default.
HealthCheckTimeout	Integer	No	No	The amount of time to wait for a response from a health check.	If a backend ECS instance does not respond within the specified time, the health check fails. Valid values: 1 to 100. Default value: 3. Unit: seconds.
HealthCheckSuccTimes	Integer	No	No	The number of consecutive successful health checks.	The number of consecutive successful health checks that must occur before an unhealthy application is considered healthy. Valid values: 1 to 10. Default value: 2.
HealthCheckMethod	String	No	No	The health check method for HTTP listeners.	Valid values: HEAD (default): Requests only the header of the page. GET: Requests the specified page information and returns the entity body.
HealthCheckPort	Integer	No	No	The port for health checks.	Valid values: 1 to 65535. Default value: 80.
HealthCheckHttpCode	String	No	No	The HTTP status code for a successful health check.	Valid values: http_2xx (default) http_3xx
HealthCheckType	String	No	No	The health check type.	Includes Layer 4 and Layer 7 probes. This parameter is empty by default. Valid values: l4: Layer 4 probe. l7: Layer 7 probe.
Remarks	String	No	No	The remarks.	This parameter is empty by default.

Return values

Fn::GetAtt

HealthCheckFailTimes: The number of consecutive failed health checks.
ServicePort: The service port number.
HealthCheckInterval: The interval between health checks.
AppStatus: The application status.
TargetPort: The backend port.
DomainName: The domain name attached to the application.
HealthCheckUri: The URI for health checks.
HealthCheckHost: The domain name for health checks.
CreateTime: The time when the application was created.
GatewayType: The gateway type.
HealthCheckTimeout: The timeout period for a health check response.
HealthCheckSuccTimes: The number of consecutive successful health checks.
QuicCid: Indicates whether QUIC support is enabled.
Remarks: The description of the application.
VersionCount: The number of application versions.
HealthCheckMethod: The health check method for HTTP listeners.
UpdateTime: The time when the application was last modified.
HealthCheckPort: The port for health checks.
EdgeContainerAppName: The application name.
HealthCheckHttpCode: The HTTP status code for a successful health check.
HealthCheckType: The health check type.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ServicePort:
    Type: Number
    Description:
      en: 'The server port. Valid values: 1 to 65535.'
    Required: true
    MinValue: 1
    MaxValue: 65535
  TargetPort:
    Type: Number
    Description:
      en: 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'
    Required: true
    MinValue: 1
    MaxValue: 65535
  EdgeContainerAppName:
    Type: String
    Description:
      en: The name of the application. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::EdgeContainerApp
    Properties:
      ServicePort:
        Ref: ServicePort
      TargetPort:
        Ref: TargetPort
      EdgeContainerAppName:
        Ref: EdgeContainerAppName
Outputs:
  HealthCheckFailTimes:
    Description: The number of consecutive failed health checks required for an application to be considered as unhealthy.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckFailTimes
  ServicePort:
    Description: The server port.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ServicePort
  HealthCheckInterval:
    Description: 'The interval between health checks. Unit: seconds.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckInterval
  AppStatus:
    Description: The status of the application.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AppStatus
  TargetPort:
    Description: The backend port, which is also the service port of the application.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TargetPort
  DomainName:
    Description: The domain name that is attached to the application. If no domain name is attached, this value is empty.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DomainName
  HealthCheckUri:
    Description: The URI for health checks.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckUri
  HealthCheckHost:
    Description: The domain name for health checks.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckHost
  CreateTime:
    Description: The time when the application was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  GatewayType:
    Description: The type of the gateway.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GatewayType
  HealthCheckTimeout:
    Description: The timeout period of a health check response.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckTimeout
  HealthCheckSuccTimes:
    Description: 'The number of consecutive successful health checks required for an unhealthy application to be considered healthy.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckSuccTimes
  QuicCid:
    Description: Indicates whether QUIC is enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QuicCid
  Remarks:
    Description: The remarks. This parameter is empty by default.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Remarks
  VersionCount:
    Description: The number of application versions.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - VersionCount
  HealthCheckMethod:
    Description: The HTTP request method for health checks.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckMethod
  UpdateTime:
    Description: The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdateTime
  HealthCheckPort:
    Description: 'The port for health checks. Valid values: 1 to 65535. Default value: 80.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckPort
  EdgeContainerAppName:
    Description: 'The application name.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - EdgeContainerAppName
  HealthCheckHttpCode:
    Description: The HTTP status code for a successful health check.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckHttpCode
  HealthCheckType:
    Description: The health check type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HealthCheckType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ServicePort": {
      "Type": "Number",
      "Description": {
        "en": "The server port. Valid values: 1 to 65535."
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 65535
    },
    "TargetPort": {
      "Type": "Number",
      "Description": {
        "en": "The backend port, which is also the service port of the application. Valid values: 1 to 65535."
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 65535
    },
    "EdgeContainerAppName": {
      "Type": "String",
      "Description": {
        "en": "The name of the application. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::EdgeContainerApp",
      "Properties": {
        "ServicePort": {
          "Ref": "ServicePort"
        },
        "TargetPort": {
          "Ref": "TargetPort"
        },
        "EdgeContainerAppName": {
          "Ref": "EdgeContainerAppName"
        }
      }
    }
  },
  "Outputs": {
    "HealthCheckFailTimes": {
      "Description": "The number of consecutive failed health checks required for an application to be considered as unhealthy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckFailTimes"
        ]
      }
    },
    "ServicePort": {
      "Description": "The server port.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ServicePort"
        ]
      }
    },
    "HealthCheckInterval": {
      "Description": "The interval between health checks. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckInterval"
        ]
      }
    },
    "AppStatus": {
      "Description": "The status of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AppStatus"
        ]
      }
    },
    "TargetPort": {
      "Description": "The backend port, which is also the service port of the application.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TargetPort"
        ]
      }
    },
    "DomainName": {
      "Description": "The domain name that is attached to the application. If no domain name is attached, this value is empty.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DomainName"
        ]
      }
    },
    "HealthCheckUri": {
      "Description": "The URI for health checks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckUri"
        ]
      }
    },
    "HealthCheckHost": {
      "Description": "The domain name for health checks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckHost"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the application was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "GatewayType": {
      "Description": "The type of the gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GatewayType"
        ]
      }
    },
    "HealthCheckTimeout": {
      "Description": "The timeout period of a health check response.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckTimeout"
        ]
      }
    },
    "HealthCheckSuccTimes": {
      "Description": "The number of consecutive successful health checks required for an unhealthy application to be considered healthy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckSuccTimes"
        ]
      }
    },
    "QuicCid": {
      "Description": "Indicates whether QUIC is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QuicCid"
        ]
      }
    },
    "Remarks": {
      "Description": "The remarks. This parameter is empty by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Remarks"
        ]
      }
    },
    "VersionCount": {
      "Description": "The number of application versions.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VersionCount"
        ]
      }
    },
    "HealthCheckMethod": {
      "Description": "The HTTP request method for health checks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckMethod"
        ]
      }
    },
    "UpdateTime": {
      "Description": "The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdateTime"
        ]
      }
    },
    "HealthCheckPort": {
      "Description": "The port for health checks. Valid values: 1 to 65535. Default value: 80.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckPort"
        ]
      }
    },
    "EdgeContainerAppName": {
      "Description": "The application name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "EdgeContainerAppName"
        ]
      }
    },
    "HealthCheckHttpCode": {
      "Description": "The HTTP status code for a successful health check.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckHttpCode"
        ]
      }
    },
    "HealthCheckType": {
      "Description": "The health check type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HealthCheckType"
        ]
      }
    }
  }
}