ALIYUN::ElasticSearchServerless::Endpoint - Resource Orchestration Service

The ALIYUN::ElasticSearchServerless::Endpoint is used to create an endpoint.

Syntax

{
  "Type": "ALIYUN::ElasticSearchServerless::Endpoint",
  "Properties": {
    "EndpointZones": List,
    "Name": String,
    "Type": String,
    "VpcId": String,
    "SecurityGroupIds": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
EndpointZones	List	Yes	Yes	The zone configuration of the endpoint.	You can configure up to 10 zones. For more information, refer to EndpointZones property.
Name	String	No	Yes	The endpoint name.	None.
Type	String	No	No	The endpoint type.	Default value: VPC.
VpcId	String	No	No	The VPC attached to the endpoint.	None.
SecurityGroupIds	List	No	Yes	The list of security group id.	None.

EndpointZones syntax

"EndpointZones": [
  {
    "ZoneId": String,
    "VSwitchId": String
  }
]

EndpointZones properties

Property	Type	Required	Editable	Description	Constraint
VSwitchId	String	Yes	No	The ID of the vSwitch.	None
ZoneId	String	Yes	No	The zone ID.	None

Return value

Fn::GetAtt

PvlEndpointId: The Id of the private link endpoint.
EndpointId: The Id of the endpoint.
Domain: The domain name of the endpoint.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Type:
    Type: String
    Description:
      en: 'Endpoint type, default value: VPC.'
    Required: false
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: The vpc id of the endpoint.
    Required: false
  EndpointZones:
    AssociationPropertyMetadata:
      Parameters:
        ZoneId:
          AssociationProperty: ZoneId
          Type: String
          Description:
            en: Availability zone ID.
          Required: true
        VSwitchId:
          AssociationPropertyMetadata:
            VpcId: ${VpcId}
            ZoneId: ${ZoneId}
          AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
          Type: String
          Description:
            en: Virtual switch ID.
          Required: true
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: The zone configurations of the endpoint.
    Required: true
    MinLength: 1
    MaxLength: 10
  Name:
    Type: String
    Description:
      en: The name of the endpoint.
    Required: false
Resources:
  Endpoint:
    Type: ALIYUN::ElasticSearchServerless::Endpoint
    Properties:
      Type:
        Ref: Type
      VpcId:
        Ref: VpcId
      EndpointZones:
        Ref: EndpointZones
      Name:
        Ref: Name
Outputs:
  PvlEndpointId:
    Description: The Id of the private link endpoint.
    Value:
      Fn::GetAtt:
        - Endpoint
        - PvlEndpointId
  EndpointId:
    Description: The Id of the endpoint.
    Value:
      Fn::GetAtt:
        - Endpoint
        - EndpointId
  Domain:
    Description: The domain of the endpoint.
    Value:
      Fn::GetAtt:
        - Endpoint
        - Domain

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Type": {
      "Type": "String",
      "Description": {
        "en": "Endpoint type, default value: VPC."
      },
      "Required": false
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The vpc id of the endpoint."
      },
      "Required": false
    },
    "EndpointZones": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "ZoneId": {
            "AssociationProperty": "ZoneId",
            "Type": "String",
            "Description": {
              "en": "Availability zone ID."
            },
            "Required": true
          },
          "VSwitchId": {
            "AssociationPropertyMetadata": {
              "VpcId": "${VpcId}",
              "ZoneId": "${ZoneId}"
            },
            "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
            "Type": "String",
            "Description": {
              "en": "Virtual switch ID."
            },
            "Required": true
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "The zone configurations of the endpoint."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 10
    },
    "Name": {
      "Type": "String",
      "Description": {
        "en": "The name of the endpoint."
      },
      "Required": false
    }
  },
  "Resources": {
    "Endpoint": {
      "Type": "ALIYUN::ElasticSearchServerless::Endpoint",
      "Properties": {
        "Type": {
          "Ref": "Type"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "EndpointZones": {
          "Ref": "EndpointZones"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "PvlEndpointId": {
      "Description": "The Id of the private link endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "Endpoint",
          "PvlEndpointId"
        ]
      }
    },
    "EndpointId": {
      "Description": "The Id of the endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "Endpoint",
          "EndpointId"
        ]
      }
    },
    "Domain": {
      "Description": "The domain of the endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "Endpoint",
          "Domain"
        ]
      }
    }
  }
}