x-amazon-apigateway-tag-value プロパティ

HTTP API の AWS タグの値を指定します。x-amazon-apigateway-tag-value プロパティを、ルートレベルの OpenAPI タグオブジェクトの一部として使用して、HTTP API の AWS タグを指定できます。x-amazon-apigateway-tag-value プロパティを指定せずにタグ名を指定すると、API Gateway は値として空の文字列を持つタグを作成します。

タグ付けの詳細については、「API Gateway リソースのタグ付け」を参照してください。

x-amazon-apigateway-tag-value の例

次の例では、HTTP API に 2 つのタグを指定します。

"tags": [
    {
      "name": "Owner",
      "x-amazon-apigateway-tag-value": "Admin"
    },
    {
      "name": "Prod"
    }
]