すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:キャパシティリザベーション

最終更新日:Mar 17, 2025

ALIYUN::ECS::CapacityReservation は、キャパシティリザベーションを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECS::CapacityReservation",
  "Properties": {
    "InstanceAmount": Integer,
    "Description": String,
    "PrivatePoolOptions": Map,
    "ZoneId": String,
    "ResourceGroupId": String,
    "EndTime": String,
    "EndTimeType": String,
    "InstanceType": String,
    "Tags": List
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

InstanceAmount

Integer

はい

はい

インスタンスタイプのキャパシティを予約するインスタンスの総数。

有効な値:1 ~ 1000。

Description

String

いいえ

はい

キャパシティリザベーションの説明。

説明は 2 ~ 256 文字の長さでなければなりません。説明には文字を含めることができ、http:// または https:// で始めることはできません。

PrivatePoolOptions

Map

いいえ

はい

キャパシティリザベーションの構成。

詳細については、「PrivatePoolOptions プロパティ」をご参照ください。

ZoneId

String

はい

いいえ

キャパシティリザベーションのゾーン ID。

キャパシティリザベーションを使用して、単一ゾーン内のリソースのみを予約できます。

ResourceGroupId

String

いいえ

いいえ

キャパシティリザベーションを割り当てるリソースグループの ID。

なし。

EndTime

String

いいえ

はい

キャパシティリザベーションの有効期限が切れる時刻。

ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC+0 でなければなりません。詳細については、「ISO 8601 時刻形式」をご参照ください。

EndTimeType

String

いいえ

はい

キャパシティリザベーションのリリースモード。

有効な値:

  • Limited:キャパシティリザベーションは、指定された時点で自動的にリリースされます。このプロパティを指定する場合は、EndTime も指定する必要があります。

  • Unlimited:キャパシティリザベーションは手動でリリースされます。キャパシティリザベーションはいつでもリリースできます。

InstanceType

String

はい

いいえ

インスタンスタイプ。

単一のインスタンスタイプのキャパシティを予約するためにキャパシティリザベーションを作成できます。DescribeInstanceTypes 操作を呼び出して、Elastic Compute Service ( ECS ) が提供するインスタンスタイプをクエリできます。

Tags

List

いいえ

いいえ

キャパシティリザベーションに追加するタグ。

最大 20 個のタグを追加できます。詳細については、「Tags プロパティ」をご参照ください。

PrivatePoolOptions 構文

"PrivatePoolOptions": {
  "MatchCriteria": String,
  "Name": String
}

PrivatePoolOptions プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

MatchCriteria

String

いいえ

いいえ

キャパシティリザベーションが有効になった後に生成されるプライベートプールのタイプ。

有効な値:

  • Open ( デフォルト ):オープン プライベートプール

  • Target:指定された プライベートプール

Name

String

いいえ

はい

キャパシティリザベーションの名前。

名前は 2 ~ 128 文字の長さでなければなりません。名前は文字で始まり、http:// または https:// で始めることはできません。名前には、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。

Tags 構文

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Value

String

いいえ

いいえ

キャパシティリザベーションに追加するタグの値。

タグ値は空の文字列を指定できます。タグ値は最大 128 文字の長さで、acs: で始めることはできません。タグ値には、http:// または https:// を含めることはできません。

Key

String

いいえ

いいえ

キャパシティリザベーションに追加するタグのキー。

タグキーは空の文字列を指定できません。タグキーは最大 128 文字の長さで、aliyun または acs: で始めることはできません。タグキーには、http:// または https:// を含めることはできません。

戻り値

Fn::GetAtt

PrivatePoolOptionsId: キャパシティリザベーションの ID。

  • YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Description:
        AssociationProperty: TextArea
        Description:
          ja: 'キャパシティリザベーションの説明。説明は 2 ~ 256 文字の長さで、http:// または https:// で始めることはできません。
    
    
            このパラメーターはデフォルトでは空です。'
        Required: false
        Type: String
      EndTime:
        Description:
          ja: キャパシティリザベーションの有効期限が切れる時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC でなければなりません。詳細については、ISO 8601 を参照してください。
        Required: false
        Type: String
      EndTimeType:
        AllowedValues:
        - Limited
        - Unlimited
        Description:
          ja: 'キャパシティリザベーションのリリースモード。有効な値:
    
            Limited:キャパシティリザベーションは、指定された時刻に自動的にリリースされます。このパラメーターを指定する場合は、EndTime パラメーターも指定する必要があります。
    
            Unlimited:キャパシティリザベーションは手動でリリースする必要があります。いつでもリリースできます。'
        Required: false
        Type: String
      InstanceAmount:
        Description:
          ja: インスタンスタイプのキャパシティを予約するインスタンスの総数。
        MaxValue: 1000
        MinValue: 1
        Required: true
        Type: Number
      InstanceType:
        Description:
          ja: インスタンスタイプ。単一のインスタンスタイプのキャパシティを予約するためにキャパシティリザベーションを作成できます。DescribeInstanceTypes 操作を呼び出して、ECS が提供するインスタンスタイプをクエリできます。
        Required: true
        Type: String
      PrivatePoolOptions:
        AssociationPropertyMetadata:
          Parameters:
            MatchCriteria:
              AllowedValues:
              - Open
              - Target
              Description:
                ja: 'キャパシティリザベーションが有効になった後に生成されるプライベートプールのタイプ。有効な値:
    
                  Open:オープン プライベートプール
    
                  Target:ターゲット プライベートプール
    
                  デフォルト値:Open。'
              Required: false
              Type: String
            Name:
              Description:
                ja: キャパシティリザベーションの名前。名前は 2 ~ 128 文字の長さでなければなりません。説明は文字で始める必要がありますが、http:// または https:// で始めることはできません。文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。
              Required: false
              Type: String
        Required: false
        Type: Json
      ResourceGroupId:
        AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
        Description:
          ja: キャパシティリザベーションを割り当てるリソースグループの ID。
        Required: false
        Type: String
      Tags:
        AssociationProperty: List[Parameters]
        AssociationPropertyMetadata:
          ListMetadata:
            Order:
            - Key
            - Value
          Parameters:
            Key:
              Description:
                ja: 'キャパシティリザベーションに追加するタグ N のキー。N の有効な値:1 ~ 20。タグキーは空の文字列を指定できません。タグキーは最大 128 文字の長さで、http:// または https:// を含めることはできません。acs: または aliyun で始めることはできません。'
              Required: false
              Type: String
            Value:
              Description:
                ja: 'キャパシティリザベーションに追加するタグ N の値。N の有効な値:1 ~ 20。タグ値は空の文字列を指定できます。タグ値は最大 128 文字の長さで、acs: で始めることはできません。タグ値には、http:// または https:// を含めることはできません。'
              Required: false
              Type: String
        MaxLength: 20
        Required: false
        Type: Json
      ZoneId:
        AssociationProperty: ZoneId
        Description:
          ja: キャパシティリザベーションを作成するリージョン内のゾーン N の ID。キャパシティリザベーションは、単一ゾーン内のリソースのみを予約できます。
        Required: true
        Type: String
    Resources:
      CapacityReservation:
        Properties:
          Description:
            Ref: Description
          EndTime:
            Ref: EndTime
          EndTimeType:
            Ref: EndTimeType
          InstanceAmount:
            Ref: InstanceAmount
          InstanceType:
            Ref: InstanceType
          PrivatePoolOptions:
            Ref: PrivatePoolOptions
          ResourceGroupId:
            Ref: ResourceGroupId
          Tags:
            Ref: Tags
          ZoneId:
            Ref: ZoneId
        Type: ALIYUN::ECS::CapacityReservation
    Outputs:
      PrivatePoolOptionsId:
        Description: キャパシティリザベーションの ID。
        Value:
          Fn::GetAtt:
          - CapacityReservation
          - PrivatePoolOptionsId
                            
  • JSON 形式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Description": {
          "AssociationProperty": "TextArea",
          "Type": "String",
          "Description": {
            "ja": "キャパシティリザベーションの説明。説明は 2 ~ 256 文字の長さで、http:// または https:// で始めることはできません。\nこのパラメーターはデフォルトでは空です。"
          },
          "Required": false
        },
        "InstanceAmount": {
          "Type": "Number",
          "Description": {
            "ja": "インスタンスタイプのキャパシティを予約するインスタンスの総数。"
          },
          "Required": true,
          "MinValue": 1,
          "MaxValue": 1000
        },
        "EndTime": {
          "Type": "String",
          "Description": {
            "ja": "キャパシティリザベーションの有効期限が切れる時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC でなければなりません。詳細については、ISO 8601 を参照してください。"
          },
          "Required": false
        },
        "PrivatePoolOptions": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "MatchCriteria": {
                "Type": "String",
                "Description": {
                  "ja": "キャパシティリザベーションが有効になった後に生成されるプライベートプールのタイプ。有効な値:\nOpen:オープン プライベートプール\nTarget:ターゲット プライベートプール\nデフォルト値:Open。"
                },
                "AllowedValues": [
                  "Open",
                  "Target"
                ],
                "Required": false
              },
              "Name": {
                "Type": "String",
                "Description": {
                  "ja": "キャパシティリザベーションの名前。名前は 2 ~ 128 文字の長さでなければなりません。説明は文字で始める必要がありますが、http:// または https:// で始めることはできません。文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。"
                },
                "Required": false
              }
            }
          },
          "Type": "Json",
          "Required": false
        },
        "ZoneId": {
          "AssociationProperty": "ZoneId",
          "Type": "String",
          "Description": {
            "ja": "キャパシティリザベーションを作成するリージョン内のゾーン N の ID。キャパシティリザベーションは、単一ゾーン内のリソースのみを予約できます。"
          },
          "Required": true
        },
        "ResourceGroupId": {
          "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
          "Type": "String",
          "Description": {
            "ja": "キャパシティリザベーションを割り当てるリソースグループの ID。"
          },
          "Required": false
        },
        "EndTimeType": {
          "Type": "String",
          "Description": {
            "ja": "キャパシティリザベーションのリリースモード。有効な値:\nLimited:キャパシティリザベーションは、指定された時刻に自動的にリリースされます。このパラメーターを指定する場合は、EndTime パラメーターも指定する必要があります。\nUnlimited:キャパシティリザベーションは手動でリリースする必要があります。いつでもリリースできます。"
          },
          "AllowedValues": [
            "Limited",
            "Unlimited"
          ],
          "Required": false
        },
        "InstanceType": {
          "Type": "String",
          "Description": {
            "ja": "インスタンスタイプ。単一のインスタンスタイプのキャパシティを予約するためにキャパシティリザベーションを作成できます。DescribeInstanceTypes 操作を呼び出して、ECS が提供するインスタンスタイプをクエリできます。"
          },
          "Required": true
        },
        "Tags": {
          "AssociationPropertyMetadata": {
            "Parameters": {
              "Value": {
                "Type": "String",
                "Description": {
                  "ja": "キャパシティリザベーションに追加するタグ N の値。N の有効な値:1 ~ 20。タグ値は空の文字列を指定できます。タグ値は最大 128 文字の長さで、acs: で始めることはできません。タグ値には、http:// または https:// を含めることはできません。"
                },
                "Required": false
              },
              "Key": {
                "Type": "String",
                "Description": {
                  "ja": "キャパシティリザベーションに追加するタグ N のキー。N の有効な値:1 ~ 20。タグキーは空の文字列を指定できません。タグキーは最大 128 文字の長さで、http:// または https:// を含めることはできません。acs: または aliyun で始めることはできません。"
                },
                "Required": false
              }
            },
            "ListMetadata": {
              "Order": [
                "Key",
                "Value"
              ]
            }
          },
          "AssociationProperty": "List[Parameters]",
          "Type": "Json",
          "Required": false,
          "MaxLength": 20
        }
      },
      "Resources": {
        "CapacityReservation": {
          "Type": "ALIYUN::ECS::CapacityReservation",
          "Properties": {
            "Description": {
              "Ref": "Description"
            },
            "InstanceAmount": {
              "Ref": "InstanceAmount"
            },
            "EndTime": {
              "Ref": "EndTime"
            },
            "PrivatePoolOptions": {
              "Ref": "PrivatePoolOptions"
            },
            "ZoneId": {
              "Ref": "ZoneId"
            },
            "ResourceGroupId": {
              "Ref": "ResourceGroupId"
            },
            "EndTimeType": {
              "Ref": "EndTimeType"
            },
            "InstanceType": {
              "Ref": "InstanceType"
            },
            "Tags": {
              "Ref": "Tags"
            }
          }
        }
      },
      "Outputs": {
        "PrivatePoolOptionsId": {
          "Description": "キャパシティリザベーションの ID。",
          "Value": {
            "Fn::GetAtt": [
              "CapacityReservation",
              "PrivatePoolOptionsId"
            ]
          }
        }
      }
    }