ALIYUN::ESA::WaitingRoom - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::ESA::WaitingRoom",
  "Properties": {
    "CookieName": String,
    "HostNameAndPath": List,
    "NewUsersPerMinute": Integer,
    "QueuingStatusCode": Integer,
    "QueuingMethod": String,
    "Status": String,
    "SiteId": Integer,
    "SessionDuration": Integer,
    "TotalActiveUsers": String,
    "WaitingRoomType": String,
    "WaitingRoomName": String,
    "CustomPageHtml": String,
    "Description": String,
    "DisableSessionRenewalEnable": String,
    "JsonResponseEnable": String,
    "Language": String,
    "QueueAllEnable": String
  }
}

Propriedades

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
CookieName	String	Sim	Sim	Nome personalizado do cookie.	Nenhuma
HostNameAndPath	List	Sim	Sim	Nome do host e caminho.	Para mais informações, consulte a propriedade HostNameAndPath.
NewUsersPerMinute	Integer	Sim	Sim	Número de novos usuários admitidos por minuto.	Nenhuma
QueuingStatusCode	Integer	Sim	Sim	Código de status da sala de espera.	Valores válidos: 200 202 429
QueuingMethod	String	Sim	Sim	Método de enfileiramento.	Valores válidos: random: Aleatório. fifo: Usuários são admitidos na ordem de chegada (primeiro a entrar, primeiro a sair). passthrough: Encaminha dados diretamente, sem processamento. reject-all: Rejeita todas as solicitações.
Status	String	Sim	Sim	Status da sala de espera.	Valores válidos: on: Ativado. off: Desativado.
SiteId	Integer	Sim	Não	ID do site.	Nenhuma
SessionDuration	Integer	Sim	Sim	Duração da sessão.	Unidade: minutos.
TotalActiveUsers	String	Sim	Sim	Número total de usuários ativos.	Nenhuma
WaitingRoomType	String	Sim	Sim	Tipo da sala de espera.	Valores válidos: default: Tipo padrão. custom: Tipo personalizado.
WaitingRoomName	String	Sim	Sim	Nome da sala de espera.	Nenhuma
CustomPageHtml	String	Não	Sim	Conteúdo HTML personalizado da página da sala de espera.	Propriedade obrigatória quando WaitingRoomType é definido como custom. O conteúdo deve estar codificado em Base64.
Description	String	Não	Sim	Descrição da sala de espera.	Nenhuma
DisableSessionRenewalEnable	String	Não	Sim	Indica se a renovação de sessão está desativada.	Valores válidos: on: Ativado. off: Desativado.
JsonResponseEnable	String	Não	Sim	Indica se as respostas no formato JSON estão ativadas.	Se ativado, o sistema retorna uma resposta no formato JSON quando o cabeçalho accept da solicitação contém "application/json". Valores válidos: on: Ativado. off: Desativado.
Language	String	Não	Sim	Idioma da página da sala de espera.	Obrigatório quando WaitingRoomType é definido como default. Valores válidos: enus: Inglês. zhcn: Chinês simplificado. zhhk: Chinês tradicional.
QueueAllEnable	String	Não	Sim	Indica se todas as solicitações recebidas devem entrar na fila obrigatoriamente.	Valores válidos: on: Ativado. off: Desativado.

Sintaxe de HostNameAndPath

"HostNameAndPath": [
  {
    "Path": String,
    "Subdomain": String,
    "Domain": String
  }
]

Propriedades de HostNameAndPath

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Domain	String	Sim	Sim	Nome de domínio.	Nenhuma
Path	String	Sim	Sim	Caminho.	Nenhuma
Subdomain	String	Sim	Sim	Subdomínio.	Nenhuma

Valores de retorno

Fn::GetAtt

HostNameAndPath: nome do host e caminho.
JsonResponseEnable: indica se as respostas no formato JSON estão ativadas.
Description: descrição da sala de espera.
WaitingRoomType: tipo da sala de espera.
DisableSessionRenewalEnable: indica se a renovação de sessão está desativada.
CookieName: nome personalizado do cookie.
WaitingRoomName: nome da sala de espera.
CustomPageHtml: conteúdo HTML personalizado da página da sala de espera.
QueueAllEnable: indica se todos os usuários estão enfileirados.
QueuingStatusCode: código de status da sala de espera.
NewUsersPerMinute: número de novos usuários admitidos por minuto.
SessionDuration: duração da sessão.
Language: idioma da página da sala de espera.
TotalActiveUsers: número total de usuários ativos.
WaitingRoomId: ID da sala de espera.
QueuingMethod: método de enfileiramento.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Status:
    Type: String
    Description:
      en: |-
        The status of the waiting room. Valid values:
        - on: Enables the waiting room.
        - off: Disables the waiting room.
    AllowedValues:
      - 'on'
      - 'off'
    Required: true
  HostNameAndPath:
    AssociationPropertyMetadata:
      Parameters:
        Path:
          Type: String
          Description:
            en: The path.
          Required: true
        Subdomain:
          Type: String
          Description:
            en: The subdomain.
          Required: true
        Domain:
          Type: String
          Description:
            en: The domain name.
          Required: true
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: The hostname and path.
    Required: true
  SiteId:
    Type: Number
    Description:
      en: The site ID.
    Required: true
  WaitingRoomType:
    Type: String
    Description:
      en: |-
        The type of the waiting room. Valid values:
        - default: The default type.
        - custom: The custom type.
    AllowedValues:
      - default
      - custom
    Required: true
  CookieName:
    Type: String
    Description:
      en: The name of the custom cookie.
    Required: true
  WaitingRoomName:
    Type: String
    Description:
      en: The name of the waiting room.
    Required: true
  QueuingStatusCode:
    Type: Number
    Description:
      en: |-
        The status code for the waiting room. Valid values:
        - 200
        - 202
        - 429
    AllowedValues:
      - 200
      - 202
      - 429
    Required: true
  NewUsersPerMinute:
    Type: Number
    Description:
      en: The number of new users admitted per minute.
    Required: true
    MinValue: 200
  SessionDuration:
    Type: Number
    Description:
      en: The session duration in minutes.
    Required: true
    MinValue: 1
  Language:
    Type: String
    Description:
      en: |-
        The language of the waiting room page. This property is required when WaitingRoomType is set to default. Valid values:
        - enus: English.
        - zhcn: Simplified Chinese.
        - zhhk: Traditional Chinese.
    AllowedValues:
      - enus
      - zhcn
      - zhhk
    Required: false
  QueuingMethod:
    Type: String
    Description:
      en: |-
        The queuing method. Valid values:
        - random: Users are admitted randomly.
        - fifo: Users are admitted in the order they arrive (first in, first out).
        - Passthrough: Users bypass the waiting room.
        - Reject-all: All users are denied access.
    AllowedValues:
      - random
      - fifo
      - Passthrough
      - Reject-all
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::ESA::WaitingRoom
    Properties:
      Status:
        Ref: Status
      HostNameAndPath:
        Ref: HostNameAndPath
      SiteId:
        Ref: SiteId
      WaitingRoomType:
        Ref: WaitingRoomType
      CookieName:
        Ref: CookieName
      QueueAllEnable:
        Ref: QueueAllEnable
      WaitingRoomName:
        Ref: WaitingRoomName
      QueuingStatusCode:
        Ref: QueuingStatusCode
      NewUsersPerMinute:
        Ref: NewUsersPerMinute
      SessionDuration:
        Ref: SessionDuration
      Language:
        Ref: Language
      QueuingMethod:
        Ref: QueuingMethod
Outputs:
  HostNameAndPath:
    Description: The hostname and path.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - HostNameAndPath
  JsonResponseEnable:
    Description: Indicates whether JSON-formatted responses are enabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - JsonResponseEnable
  Description:
    Description: The description of the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  WaitingRoomType:
    Description: The type of the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomType
  DisableSessionRenewalEnable:
    Description: Indicates whether session renewal is disabled.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DisableSessionRenewalEnable
  CookieName:
    Description: The custom cookie name.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CookieName
  WaitingRoomName:
    Description: The name of the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomName
  CustomPageHtml:
    Description: The custom HTML content for the waiting room page. This value is returned only when WaitingRoomType is set to custom. The content is Base64-encoded.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CustomPageHtml
  QueueAllEnable:
    Description: Indicates whether all users are queued.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueueAllEnable
  QueuingStatusCode:
    Description: The status code for the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingStatusCode
  NewUsersPerMinute:
    Description: The number of new users admitted per minute.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NewUsersPerMinute
  SessionDuration:
    Description: The session duration in minutes.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SessionDuration
  Language:
    Description: The language of the waiting room page. This value is returned only when WaitingRoomType is set to default.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Language
  TotalActiveUsers:
    Description: The total number of active users.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TotalActiveUsers
  WaitingRoomId:
    Description: The ID of the waiting room.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WaitingRoomId
  QueuingMethod:
    Description: The queuing method.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - QueuingMethod

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Status": {
      "Type": "String",
      "Description": {
        "en": "The status of the waiting room. Valid values:\n- on: Enables the waiting room.\n- off: Disables the waiting room."
      },
      "AllowedValues": [
        "on",
        "off"
      ],
      "Required": true
    },
    "HostNameAndPath": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "Path": {
            "Type": "String",
            "Description": {
              "en": "The path."
            },
            "Required": true
          },
          "Subdomain": {
            "Type": "String",
            "Description": {
              "en": "The subdomain."
            },
            "Required": true
          },
          "Domain": {
            "Type": "String",
            "Description": {
              "en": "The domain name."
            },
            "Required": true
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "The hostname and path."
      },
      "Required": true
    },
    "SiteId": {
      "Type": "Number",
      "Description": {
        "en": "The site ID."
      },
      "Required": true
    },
    "WaitingRoomType": {
      "Type": "String",
      "Description": {
        "en": "The type of the waiting room. Valid values:\n- default: The default type.\n- custom: The custom type."
      },
      "AllowedValues": [
        "default",
        "custom"
      ],
      "Required": true
    },
    "CookieName": {
      "Type": "String",
      "Description": {
        "en": "The name of the custom cookie."
      },
      "Required": true
    },
    "WaitingRoomName": {
      "Type": "String",
      "Description": {
        "en": "The name of the waiting room."
      },
      "Required": true
    },
    "QueuingStatusCode": {
      "Type": "Number",
      "Description": {
        "en": "The status code for the waiting room. Valid values:\n- 200\n- 202\n- 429"
      },
      "AllowedValues": [
        200,
        202,
        429
      ],
      "Required": true
    },
    "NewUsersPerMinute": {
      "Type": "Number",
      "Description": {
        "en": "The number of new users admitted per minute."
      },
      "Required": true,
      "MinValue": 200
    },
    "SessionDuration": {
      "Type": "Number",
      "Description": {
        "en": "The session duration in minutes."
      },
      "Required": true,
      "MinValue": 1
    },
    "Language": {
      "Type": "String",
      "Description": {
        "en": "The language of the waiting room page. This property is required when WaitingRoomType is set to default. Valid values:\n- enus: English.\n- zhcn: Simplified Chinese.\n- zhhk: Traditional Chinese."
      },
      "AllowedValues": [
        "enus",
        "zhcn",
        "zhhk"
      ],
      "Required": false
    },
    "QueuingMethod": {
      "Type": "String",
      "Description": {
        "en": "The queuing method. Valid values:\n- random: Users are admitted randomly.\n- fifo: Users are admitted in the order they arrive (first in, first out).\n- Passthrough: Users bypass the waiting room.\n- Reject-all: All users are denied access."
      },
      "AllowedValues": [
        "random",
        "fifo",
        "Passthrough",
        "Reject-all"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ESA::WaitingRoom",
      "Properties": {
        "Status": {
          "Ref": "Status"
        },
        "HostNameAndPath": {
          "Ref": "HostNameAndPath"
        },
        "SiteId": {
          "Ref": "SiteId"
        },
        "WaitingRoomType": {
          "Ref": "WaitingRoomType"
        },
        "CookieName": {
          "Ref": "CookieName"
        },
        "QueueAllEnable": {
          "Ref": "QueueAllEnable"
        },
        "WaitingRoomName": {
          "Ref": "WaitingRoomName"
        },
        "QueuingStatusCode": {
          "Ref": "QueuingStatusCode"
        },
        "NewUsersPerMinute": {
          "Ref": "NewUsersPerMinute"
        },
        "SessionDuration": {
          "Ref": "SessionDuration"
        },
        "Language": {
          "Ref": "Language"
        },
        "QueuingMethod": {
          "Ref": "QueuingMethod"
        }
      }
    }
  },
  "Outputs": {
    "HostNameAndPath": {
      "Description": "The hostname and path.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "HostNameAndPath"
        ]
      }
    },
    "JsonResponseEnable": {
      "Description": "Indicates whether JSON-formatted responses are enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "JsonResponseEnable"
        ]
      }
    },
    "Description": {
      "Description": "The description of the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "WaitingRoomType": {
      "Description": "The type of the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomType"
        ]
      }
    },
    "DisableSessionRenewalEnable": {
      "Description": "Indicates whether session renewal is disabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DisableSessionRenewalEnable"
        ]
      }
    },
    "CookieName": {
      "Description": "The custom cookie name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CookieName"
        ]
      }
    },
    "WaitingRoomName": {
      "Description": "The name of the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomName"
        ]
      }
    },
    "CustomPageHtml": {
      "Description": "The custom HTML content for the waiting room page. This value is returned only when WaitingRoomType is set to custom. The content is Base64-encoded.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CustomPageHtml"
        ]
      }
    },
    "QueueAllEnable": {
      "Description": "Indicates whether all users are queued.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueueAllEnable"
        ]
      }
    },
    "QueuingStatusCode": {
      "Description": "The status code for the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingStatusCode"
        ]
      }
    },
    "NewUsersPerMinute": {
      "Description": "The number of new users admitted per minute.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NewUsersPerMinute"
        ]
      }
    },
    "SessionDuration": {
      "Description": "The session duration in minutes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SessionDuration"
        ]
      }
    },
    "Language": {
      "Description": "The language of the waiting room page. This value is returned only when WaitingRoomType is set to default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Language"
        ]
      }
    },
    "TotalActiveUsers": {
      "Description": "The total number of active users.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TotalActiveUsers"
        ]
      }
    },
    "WaitingRoomId": {
      "Description": "The ID of the waiting room.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WaitingRoomId"
        ]
      }
    },
    "QueuingMethod": {
      "Description": "The queuing method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "QueuingMethod"
        ]
      }
    }
  }
}