DATASOURCE::MNS::Queue リソース属性リファレンス - ROS

DATASOURCE::MNS::Queue は、作成されたキューに関する情報を照会するために使用されます。

構文

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

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

QueueName

String

はい

キュー名。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

ActiveMessages: キュー内のアクティブなメッセージの総数。
PollingWaitSeconds: キューにメッセージが存在しない場合に ReceiveMessage リクエストが待機する最大期間。
MaximumMessageSize: キューに送信されるメッセージ本文の最大サイズ。
CreateTime: キューの作成時間。
VisibilityTimeout: メッセージがキューから受信された後、メッセージが非アクティブ状態のままになる期間。
QueueInternalUrl: キューの内部 URL。
LastModifyTime: キューの最新の変更時間。
QueueUrl: キューの URL。
LoggingEnabled: ログ管理機能が有効になっているかどうかを示します。
DelayMessages: キュー内の遅延メッセージの総数。
DelaySeconds: キューに送信されたすべてのメッセージが消費されるまでの遅延期間。
MessageRetentionPeriod: メッセージがキューに保持される最大期間。
InactiveMessages: キュー内の非アクティブなメッセージの総数。
QueueName: キュー名。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueueName:
    Type: String
    Description:
      en: The name of the MNS queue.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::MNS::Queue
    Properties:
      QueueName:
        Ref: QueueName
Outputs:
  ActiveMessages:
    Description: The total number of active messages in the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ActiveMessages
  PollingWaitSeconds:
    Description: The maximum time period that a ReceiveMessage request can wait till a message is in the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PollingWaitSeconds
  MaximumMessageSize:
    Description: The maximum size of a message that can be sent to the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MaximumMessageSize
  CreateTime:
    Description: The time when the queue was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  VisibilityTimeout:
    Description: The duration for which a message stays in the Inactive state after it is consumed from the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VisibilityTimeout
  QueueInternalUrl:
    Description: The internal URL of the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - QueueInternalUrl
  LastModifyTime:
    Description: The most recent time when the queue was modified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LastModifyTime
  QueueUrl:
    Description: The URL of the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - QueueUrl
  LoggingEnabled:
    Description: Specifies whether to enable the log management feature.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoggingEnabled
  DelayMessages:
    Description: The total number of delayed messages in the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DelayMessages
  DelaySeconds:
    Description: The delay time after which all messages that are sent to the queue can be consumed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DelaySeconds
  MessageRetentionPeriod:
    Description: The maximum lifetime of a message in the queue. After the time that is specified by this parameter expires, the message is deleted, regardless of whether the message has been consumed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MessageRetentionPeriod
  InactiveMessages:
    Description: The total number of inactive messages in the queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InactiveMessages
  QueueName:
    Description: The name of the MNS queue.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - QueueName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueueName": {
      "Type": "String",
      "Description": {
        "en": "The name of the MNS queue."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::MNS::Queue",
      "Properties": {
        "QueueName": {
          "Ref": "QueueName"
        }
      }
    }
  },
  "Outputs": {
    "ActiveMessages": {
      "Description": "キュー内のアクティブなメッセージの総数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ActiveMessages"
        ]
      }
    },
    "PollingWaitSeconds": {
      "Description": "ReceiveMessage リクエストがメッセージがキューに入るまで待機できる最大期間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PollingWaitSeconds"
        ]
      }
    },
    "MaximumMessageSize": {
      "Description": "キューに送信できるメッセージの最大サイズ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaximumMessageSize"
        ]
      }
    },
    "CreateTime": {
      "Description": "キューが作成された時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "VisibilityTimeout": {
      "Description": "メッセージがキューから消費された後、非アクティブ状態のままである期間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VisibilityTimeout"
        ]
      }
    },
    "QueueInternalUrl": {
      "Description": "キューの内部 URL。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "QueueInternalUrl"
        ]
      }
    },
    "LastModifyTime": {
      "Description": "キューが最後に変更された時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LastModifyTime"
        ]
      }
    },
    "QueueUrl": {
      "Description": "キューの URL。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "QueueUrl"
        ]
      }
    },
    "LoggingEnabled": {
      "Description": "ログ管理機能を有効にするかどうかを指定します。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoggingEnabled"
        ]
      }
    },
    "DelayMessages": {
      "Description": "キュー内の遅延メッセージの総数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DelayMessages"
        ]
      }
    },
    "DelaySeconds": {
      "Description": "キューに送信されたすべてのメッセージが消費されるまでの遅延時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DelaySeconds"
        ]
      }
    },
    "MessageRetentionPeriod": {
      "Description": "キュー内のメッセージの最大有効期間。このパラメーターで指定された時間が経過すると、メッセージが消費されたかどうかに関係なく、メッセージは削除されます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MessageRetentionPeriod"
        ]
      }
    },
    "InactiveMessages": {
      "Description": "キュー内の非アクティブなメッセージの総数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InactiveMessages"
        ]
      }
    },
    "QueueName": {
      "Description": "MNS キューの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "QueueName"
        ]
      }
    }
  }
}