edit-icon download-icon

ALIYUN::ApiGateway::Group

Last Updated: Jun 13, 2018

ALIYUN::ApiGateway::Group is used to create API groups.

Syntax

  1. {
  2. "Type" : "ALIYUN::ApiGateway::Group",
  3. "Properties" : {
  4. "GroupName" : String,
  5. "Description" : String
  6. }
  7. }

Properties

Name Type Required Update allowed Description
GroupName string Yes Yes The name of a group must be unique. It can contain 4 to 50 characters including English letters, numbers, underscores (_), and must begin with an English letter.
Description string No Yes API group description. It contains up to 180 characters.

Return values

Fn::GetAtt

  • SubDomain: The sub domain assigned to the Group by the system.
  • GroupId: The ID of the created Group resource.

Example

  1. {
  2. "ROSTemplateFormatVersion": "2015-09-01",
  3. "Description": "Create a group",
  4. "Resources": {
  5. "Group": {
  6. "Type": "ALIYUN::ApiGateway::Group",
  7. "Properties": {
  8. "GroupName": "demo_group",
  9. "Description": "demo"
  10. }
  11. }
  12. },
  13. "Outputs": {
  14. "GroupId": {
  15. "Description": "Group ID",
  16. "Value": {
  17. "Fn::GetAtt": [
  18. "Group",
  19. "GroupId"
  20. ]
  21. }
  22. },
  23. "SubDomain": {
  24. "Description": "Sub Domain",
  25. "Value": {
  26. "Fn::GetAtt": [
  27. "Group",
  28. "SubDomain"
  29. ]
  30. }
  31. }
  32. }
  33. }
Thank you! We've received your feedback.