ALIYUN::MSE::GatewayDomain - Resource Orchestration Service

You can use ALIYUN::MSE::GatewayDomain to add an associated domain to a gateway.

Syntax

{
  "Type": "ALIYUN::MSE::GatewayDomain",
  "Properties": {
    "GatewayUniqueId": String,
    "Name": String,
    "Protocol": String,
    "CertIdentifier": String,
    "Http2": String,
    "MustHttps": Boolean,
    "TlsMax": String,
    "TlsMin": String,
    "TlsCipherSuitesConfigJSON": Map
  }
}

Properties

Property Name	Type	Required	Update Allowed	Description	Constraints
GatewayUniqueId	String	Yes	No	The unique ID of the gateway.	None
Name	String	Yes	No	The domain name.	None
Protocol	String	Yes	No	The protocol type.	Valid values: `HTTP` `HTTPS`
CertIdentifier	String	No	No	The ID of the certificate.	None
Http2	String	No	No	Specifies whether to enable HTTP/2.	Valid values: `open`: Enables `HTTP/2`. `close`: Disables `HTTP/2`. `globalConfig`: Uses the global configuration.
MustHttps	Boolean	No	No	Specifies whether to enable HTTPS.	None
TlsMax	String	No	No	The maximum version of Transport Layer Security (TLS).	None
TlsMin	String	No	No	The minimum version of TLS.	None
TlsCipherSuitesConfigJSON	Map	No	No	The configuration of the TLS cipher suite.	For more information, see the TlsCipherSuitesConfigJSON property.

TlsCipherSuitesConfigJSON syntax

"TlsCipherSuitesConfigJSON": {
  "TlsCipherSuites": List,
  "ConfigType": String
}

TlsCipherSuitesConfigJSON properties

Property Name	Type	Required	Update Allowed	Description	Constraints
ConfigType	String	No	No	The type of the cipher suite configuration.	None
TlsCipherSuites	List	No	No	A list of cipher suite names.	None

Return values

Fn::GetAtt

DomainId: The ID of the domain.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GatewayUniqueId:
    Type: String
    Description:
      en: The unique identifier of the gateway.
    Required: true
  Protocol:
    Type: String
    Description:
      en: 'The protocol type: HTTP, HTTPS.'
    AllowedValues:
      - HTTP
      - HTTPS
    Required: true
  Name:
    Type: String
    Description:
      en: The domain name.
    Required: true
Resources:
  GatewayDomain:
    Type: ALIYUN::MSE::GatewayDomain
    Properties:
      GatewayUniqueId:
        Ref: GatewayUniqueId
      Protocol:
        Ref: Protocol
      Name:
        Ref: Name
Outputs:
  DomainId:
    Description: The ID of the domain.
    Value:
      Fn::GetAtt:
        - GatewayDomain
        - DomainId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GatewayUniqueId": {
      "Type": "String",
      "Description": {
        "en": "The unique identifier of the gateway."
      },
      "Required": true
    },
    "Protocol": {
      "Type": "String",
      "Description": {
        "en": "The protocol type: HTTP, HTTPS."
      },
      "AllowedValues": [
        "HTTP",
        "HTTPS"
      ],
      "Required": true
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The domain name."
      },
      "Required": true
    }
  },
  "Resources": {
    "GatewayDomain": {
      "Type": "ALIYUN::MSE::GatewayDomain",
      "Properties": {
        "GatewayUniqueId": {
          "Ref": "GatewayUniqueId"
        },
        "Protocol": {
          "Ref": "Protocol"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "DomainId": {
      "Description": "The ID of the domain.",
      "Value": {
        "Fn::GetAtt": [
          "GatewayDomain",
          "DomainId"
        ]
      }
    }
  }
}