ALIYUN::AMQP::Queue リソースタイプの構文とプロパティ - ROS

ALIYUN::AMQP::Queue は、キューを作成するために使用されます。

構文

{
  "Type": "ALIYUN::AMQP::Queue",
  "Properties": {
    "DeadLetterExchange": String,
    "MaximumPriority": Number,
    "InstanceId": String,
    "ExclusiveState": Boolean,
    "DeadLetterRoutingKey": String,
    "VirtualHost": String,
    "MaxLength": Number,
    "AutoDeleteState": Boolean,
    "QueueName": String,
    "MessageTTL": Number,
    "AutoExpireState": Number
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
InstanceId	String	はい	いいえ	インスタンス ID。	なし。
QueueName	String	はい	いいえ	キュー名。	名前を指定する場合は、次の点に注意してください。名前は 1 ～ 255 文字で、英字、数字、ハイフン（-）、アンダースコア（_）、ピリオド（.）、番号記号（#）、スラッシュ（/）、アットマーク（@）のみ使用できます。キューの作成後、キューの名前を変更することはできません。名前を変更する場合は、キューを削除して新しいキューを作成する必要があります。
VirtualHost	String	はい	いいえ	vhost 名。	vhost 名には、英字、数字、ハイフン（-）、アンダースコア（_）、ピリオド（.）、番号記号（#）、スラッシュ（/）、アットマーク（@）のみ使用できます。 vhost 名は 1 ～ 255 文字である必要があります。
AutoDeleteState	Boolean	いいえ	いいえ	キューを自動的に削除するかどうかを指定します。	有効な値： true: キューを自動的に削除します。コンシューマーからキューへの最後のサブスクリプションがキャンセルされると、キューは自動的に削除されます。 false: キューを自動的に削除しません。
AutoExpireState	Number	いいえ	いいえ	キューが期限切れになるまでの期間。	指定された期間内にキューにアクセスがない場合、キューは自動的に削除されます。説明このプロパティに対応する機能は、機能を有効にした後にのみ使用できます。この機能を使用するには、[チケットを送信する] 必要があります。
DeadLetterExchange	String	いいえ	いいえ	デッドレター交換。	デッドレター交換は、拒否されたメッセージを受信するために使用されます。コンシューマーが再試行できないメッセージを拒否した場合、ApsaraMQ for RabbitMQ はメッセージを指定されたデッドレター交換にルーティングします。次に、デッドレター交換は、メッセージを保存するためにデッドレター交換にバインドされているキューにルーティングします。
DeadLetterRoutingKey	String	いいえ	いいえ	デッドレタールーティングキー。	キー名には、英字、数字、ハイフン（-）、アンダースコア（_）、ピリオド（.）、番号記号（#）、スラッシュ（/）、アットマーク（@）のみ使用できます。キー名は 1 ～ 255 文字である必要があります。
ExclusiveState	Boolean	いいえ	いいえ	交換が排他的交換かどうかを指定します。	有効な値： true: 交換は排他的交換です。排他的交換を宣言した接続のみが、排他的交換を使用できます。接続が閉じられると、排他的交換は自動的に削除されます。 false: 交換は排他的交換ではありません。
MaximumPriority	Number	いいえ	いいえ	キューの優先順位はサポートされていません。	なし。
MaxLength	Number	いいえ	いいえ	キュー内のメッセージの最大数。	このパラメーターは、ApsaraMQ for RabbitMQ の現在のバージョンでは使用できません。キュー内のメッセージの最大数を超えると、キューに格納されている最も古いメッセージが削除されます。
MessageTTL	Number	いいえ	いいえ	キュー内のメッセージの有効期間（TTL）。単位：ミリ秒。	メッセージ TTL を指定する場合は、次の点に注意してください。キュー内のメッセージの保存期間がメッセージ TTL を超えると、メッセージは期限切れになります。このプロパティの値は、負でない整数である必要があります。このパラメーターの最大値は 86400 です。単位：ミリ秒。たとえば、メッセージ TTL が 1,000 ミリ秒の場合、メッセージはキューに最大 1 秒間保持できます。

戻り値

Fn::GetAtt

QueueName: キュー名。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: InstanceId  # インスタンスID
  VirtualHost:
    Type: String
    Description: The name of the virtual host. # 仮想ホストの名前
  QueueName:
    Type: String
    Description: The name of the queue. # キューの名前
    MaxLength: 255
Resources:
  Queue:
    Type: ALIYUN::AMQP::Queue
    Properties:
      InstanceId:
        Ref: InstanceId
      VirtualHost:
        Ref: VirtualHost
      QueueName:
        Ref: QueueName
Outputs:
  QueueName:
    Description: The name of the queue. # キューの名前
    Value:
      Fn::GetAtt:
        - Queue
        - QueueName

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "InstanceId" // インスタンスID
    },
    "VirtualHost": {
      "Type": "String",
      "Description": "The name of the virtual host." // 仮想ホストの名前
    },
    "QueueName": {
      "Type": "String",
      "Description": "The name of the queue.", // キューの名前
      "MaxLength": 255
    }
  },
  "Resources": {
    "Queue": {
      "Type": "ALIYUN::AMQP::Queue",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "VirtualHost": {
          "Ref": "VirtualHost"
        },
        "QueueName": {
          "Ref": "QueueName"
        }
      }
    }
  },
  "Outputs": {
    "QueueName": {
      "Description": "The name of the queue.", // キューの名前
      "Value": {
        "Fn::GetAtt": [
          "Queue",
          "QueueName"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式