DATASOURCE::MNS::Queues

DATASOURCE::MNS::Queues类型用于查询指定阿里云账号下的所有队列(Queue)。

语法

{
  "Type": "DATASOURCE::MNS::Queues",
  "Properties": {
    "QueueName": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

QueueName

String

Queue的名称。

RefreshOptions

String

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

返回数据(Fn::GetAtt)

  • QueueNames:Queue的名称列表。

  • Queues:Queue的详情列表。

属性名称

类型

描述

约束

QueueNames

List

Queue的名称列表。

Queues

List

Queue的详情列表。

QueueName

String

Queue的名称。

QueueUrl

String

Queue的外网URL。

QueueInternalUrl

String

Queue的内网URL。

CreateTime

String

Queue的创建时间。

从1970-01-01 00:00:00到现在的时间。

LastModifyTime

String

修改Queue属性信息的最近时间。

从1970-01-01 00:00:00到现在的时间。

DelaySeconds

Number

发送到该Queue的所有消息的延迟时间。

发送到队列的消息经过该参数设定的延时时间后,才能被消费。

单位:秒。

MaximumMessageSize

Number

发送到该Queue的消息体的最大长度。

单位:Byte。

MessageRetentionPeriod

Number

消息在该Queue中最长的存活时间。

从发送到该队列开始经过该参数指定的时间后,不论消息是否被取出过都将被删除。

单位:秒。

VisibilityTimeout

Number

消息被接收后的隐藏时长。

取值范围:1~43200秒(12小时)。

单位:秒。

PollingWaitSeconds

Number

该Queue的ReceiveMessage请求最长的等待时间。

取值范围:0~30秒。

单位:秒。

ActiveMessages

Number

在该Queue中处于Active状态的消息总数。

InactiveMessages

Number

在该Queue中处于Inactive状态的消息总数。

DelayMessages

Number

在该Queue中处于Delayed状态的消息总数。

LoggingEnabled

Boolean

是否开启日志管理功能。

取值:

  • True:启用。

  • False:停用。

示例

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueueName": {
      "Type": "String",
      "Description": "Queue name."
    }
  },
  "Resources": {
    "Queues": {
      "Type": "DATASOURCE::MNS::Queues",
      "Properties": {
        "QueueName": {
          "Ref": "QueueName"
        }
      }
    }
  },
  "Outputs": {
    "QueueNames": {
      "Description": "The list of queue names.",
      "Value": {
        "Fn::GetAtt": [
          "Queues",
          "QueueNames"
        ]
      }
    },
    "Queues": {
      "Description": "The list of queues.",
      "Value": {
        "Fn::GetAtt": [
          "Queues",
          "Queues"
        ]
      }
    }
  }
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueueName:
    Type: String
    Description: Queue name.
Resources:
  Queues:
    Type: DATASOURCE::MNS::Queues
    Properties:
      QueueName:
        Ref: QueueName
Outputs:
  QueueNames:
    Description: The list of queue names.
    Value:
      Fn::GetAtt:
        - Queues
        - QueueNames
  Queues:
    Description: The list of queues.
    Value:
      Fn::GetAtt:
        - Queues
        - Queues