ALIYUN::FC::CustomDomain-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::FC::CustomDomain resource creates a custom domain name.

Syntax

{
  "Type": "ALIYUN::FC::CustomDomain",
  "Properties": {
    "ApiVersion": String,
    "Protocol": String,
    "RouteConfig": Map,
    "CertConfig": Map,
    "DomainName": String
  }
}

Properties

Property	Type	Required	Update allowed	Description	Constraints
ApiVersion	String	No	Yes	The API edition.	None
Protocol	String	Yes	Yes	Protocol Type	Valid values: HTTP HTTPS
RouteConfig	Map	No	Yes	The route table configuration.	For more information, see RouteConfig properties.
CertConfig	Map	No	Yes	The certificate information.	For more information, see CertConfig properties.
DomainName	String	Yes	No	The domain name.	None

RouteConfig syntax

"RouteConfig": {
  "Routes": List
}

RouteConfig properties

Property Name	Type	Required	Update allowed	Description	Constraints
Routes	List	Yes	Yes	The list of routes.	For more information, see Routes properties.

Routes syntax

"Routes": [
  {
    "Path": String,
    "FunctionName": String,
    "ServiceName": String,
    "Qualifier": String
  }
]

Routes properties

Property	Type	Required	Update allowed	Description	Constraints
Path	String	Yes	Yes	The request path of the custom domain name. For example: `/login/*`.	None
Qualifier	String	No	No	The alias.	None
FunctionName	String	Yes	Yes	The function that corresponds to the request path.	None
ServiceName	String	Yes	Yes	The service to which the function belongs.	None

CertConfig syntax

"CertConfig": {
  "CertName": String,
  "PrivateKey": String,
  "Certificate": String
}

CertConfig properties

Property Name	Type	Required	Update allowed	Description	Constraints
CertName	String	Yes	Yes	The custom name of the certificate.	None
PrivateKey	String	Yes	Yes	The private key.	Use the line feed character `\n` to format the key as a single line.
Certificate	String	Yes	Yes	The certificate content.	Written on a single line, where the line feed character `\n` denotes line breaks.

Return values

Fn::GetAtt

DomainName: The domain name.
Domain: The protocol and the domain name.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  CustomDomain:
    Type: ALIYUN::FC::CustomDomain
    Properties:
      Protocol: HTTP
      DomainName: TestDomain
Outputs:
  DomainName:
    Description: The domain name
    Value:
      Fn::GetAtt:
        - CustomDomain
        - DomainName
  Domain:
    Description: The domain with protocol.
    Value:
      Fn::GetAtt:
        - CustomDomain
        - Domain

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "CustomDomain": {
      "Type": "ALIYUN::FC::CustomDomain",
      "Properties": {
        "Protocol": "HTTP",
        "DomainName": "TestDomain"
      }
    }
  },
  "Outputs": {
    "DomainName": {
      "Description": "The domain name",
      "Value": {
        "Fn::GetAtt": [
          "CustomDomain",
          "DomainName"
        ]
      }
    },
    "Domain": {
      "Description": "The domain with protocol.",
      "Value": {
        "Fn::GetAtt": [
          "CustomDomain",
          "Domain"
        ]
      }
    }
  }
}