すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:キャパシティ予約

    ドキュメントセンター

    Resource Orchestration Service:キャパシティ予約

    最終更新日:Mar 17, 2025

    ALIYUN::ECS::ElasticityAssurance は、キャパシティ予約を作成するために使用されます。

    構文

    {
  "Type": "ALIYUN::ECS::ElasticityAssurance",
  "Properties": {
    "Description": String,
    "InstanceAmount": Integer,
    "PrivatePoolOptions": Map,
    "ZoneId": String,
    "ResourceGroupId": String,
    "StartTime": String,
    "Period": Integer,
    "InstanceTypes": List,
    "Tags": List,
    "PeriodUnit": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    Description

    String

    いいえ

    はい

    キャパシティ予約の説明。

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

    InstanceAmount

    Integer

    はい

    いいえ

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

    有効な値：1 ～ 1000。

    PrivatePoolOptions

    Map

    いいえ

    はい

    キャパシティ予約の構成。

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

    ZoneId

    String

    はい

    いいえ

    キャパシティ予約のゾーン ID。

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

    ResourceGroupId

    String

    いいえ

    いいえ

    キャパシティ予約を割り当てるリソースグループの ID。

    なし。

    StartTime

    String

    いいえ

    いいえ

    キャパシティ予約が有効になる時刻。

    デフォルト値は、ALIYUN::ECS::ElasticityAssurance を使用してキャパシティ予約が作成された時刻です。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC+0 でなければなりません。詳細については、「ISO 8601 時刻形式」をご参照ください。

    Period

    Integer

    いいえ

    いいえ

    予約期間。

    予約期間の単位は、PeriodUnit の値によって決まります。

    • PeriodUnit が Month に設定されている場合の Period の有効な値：1 ～ 9。

    • PeriodUnit が Year に設定されている場合の Period の有効な値：1 ～ 5。

    InstanceTypes

    List

    はい

    いいえ

    インスタンスタイプ。

    単一のインスタンスタイプのキャパシティを予約するためにキャパシティ予約を作成できます。

    Tags

    List

    いいえ

    いいえ

    キャパシティ予約に追加するタグ。

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

    PeriodUnit

    String

    いいえ

    いいえ

    予約期間の単位。

    有効な値：

    • Month

    • Year (デフォルト)

    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
  InstanceAmount:
    Description:
      ja: 'インスタンスタイプのキャパシティを予約するインスタンスの総数。

        有効な値：1～1000。'
    MaxValue: 1000
    MinValue: 1
    Required: true
    Type: Number
  InstanceTypes:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Required: false
        Type: String
    Description:
      ja: インスタンスタイプ。現在、キャパシティ予約は単一のインスタンスタイプのキャパシティを予約するために作成できます。
    MaxLength: 1
    MinLength: 1
    Required: true
    Type: Json
  Period:
    AssociationProperty: PayPeriod
    Description:
      ja: 'キャパシティ予約の有効期間。有効期間の単位はPeriodUnitの値によって決まります。有効な値：

        PeriodUnitパラメータがMonthに設定されている場合、有効な値は1、2、3、4、5、6、7、8、9です。

        PeriodUnitパラメータがYearに設定されている場合、有効な値は1、2、3、4、5です。

        デフォルト値：1。'
    Required: false
    Type: Number
  PeriodUnit:
    AllowedValues:
    - Month
    - Year
    AssociationProperty: PayPeriodUnit
    Description:
      ja: 'キャパシティ予約の有効期間の単位。有効な値：

        Month

        Year

        デフォルト値：Year。'
    Required: false
    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
  StartTime:
    Description:
      ja: キャパシティ予約が有効になる時刻。デフォルト値は、CreateElasticityAssurance操作が呼び出されてキャパシティ予約が作成された時刻です。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC でなければなりません。詳細については、ISO 8601 を参照してください。
    Required: false
    Type: String
  Tags:
    AssociationProperty: List[Parameters]
    AssociationPropertyMetadata:
      ListMetadata:
        Order:
        - Key
        - Value
      Parameters:
        Key:
          Description:
            ja: 'キャパシティ予約に追加するタグNのキー。Nの有効な値：1～20。タグキーは空の文字列を指定できません。タグキーは1～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: キャパシティ予約のゾーンID。現在、キャパシティ予約は単一のゾーン内のリソースを予約するために使用できます。
    Required: true
    Type: String
Resources:
  ElasticityAssurance:
    Properties:
      Description:
        Ref: Description
      InstanceAmount:
        Ref: InstanceAmount
      InstanceTypes:
        Ref: InstanceTypes
      Period:
        Ref: Period
      PeriodUnit:
        Ref: PeriodUnit
      PrivatePoolOptions:
        Ref: PrivatePoolOptions
      ResourceGroupId:
        Ref: ResourceGroupId
      StartTime:
        Ref: StartTime
      Tags:
        Ref: Tags
      ZoneId:
        Ref: ZoneId
    Type: ALIYUN::ECS::ElasticityAssurance
Outputs:
  PrivatePoolOptionsId:
    Description: キャパシティ予約のID。
    Value:
      Fn::GetAtt:
      - ElasticityAssurance
      - 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": "インスタンスタイプのキャパシティを予約するインスタンスの総数。\n有効な値: 1 ～ 1000。"
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 1000
    },
    "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": "キャパシティ予約のゾーン ID。現在、キャパシティ予約は単一のゾーン内のリソースを予約するために使用できます。"
      },
      "Required": true
    },
    "ResourceGroupId": {
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Type": "String",
      "Description": {
        "ja": "キャパシティ予約を割り当てるリソースグループの ID。"
      },
      "Required": false
    },
    "StartTime": {
      "Type": "String",
      "Description": {
        "ja": "キャパシティ予約が有効になる時刻。デフォルト値は、CreateElasticityAssurance 操作が呼び出されてキャパシティ予約が作成された時刻です。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC でなければなりません。詳細については、ISO 8601 を参照してください。"
      },
      "Required": false
    },
    "Period": {
      "AssociationProperty": "PayPeriod",
      "Type": "Number",
      "Description": {
        "ja": "キャパシティ予約の有効期間。有効期間の単位は PeriodUnit 値によって決まります。有効な値:\nPeriodUnit パラメータが Month に設定されている場合、有効な値は 1, 2, 3, 4, 5, 6, 7, 8, 9 です。\nPeriodUnit パラメータが Year に設定されている場合、有効な値は 1, 2, 3, 4, 5 です。\nデフォルト値: 1。"
      },
      "Required": false
    },
    "InstanceTypes": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "インスタンスタイプ。現在、キャパシティ予約は単一のインスタンスタイプのキャパシティを予約するために作成できます。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 1
    },
    "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。タグキーは空の文字列を指定できません。タグキーは 1 ～ 128 文字で、http:// または https:// を含めることはできません。タグキーは acs: または aliyun で始めることはできません。"
            },
            "Required": false
          }
        },
        "ListMetadata": {
          "Order": [
            "Key",
            "Value"
          ]
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Required": false,
      "MaxLength": 20
    },
    "PeriodUnit": {
      "AssociationProperty": "PayPeriodUnit",
      "Type": "String",
      "Description": {
        "ja": "キャパシティ予約の有効期間の単位。有効な値:\nMonth\nYear\nデフォルト値: Year。"
      },
      "AllowedValues": [
        "Month",
        "Year"
      ],
      "Required": false
    }
  },
  "Resources": {
    "ElasticityAssurance": {
      "Type": "ALIYUN::ECS::ElasticAssurance",
      "Properties": {
        "Description": {
          "Ref": "Description"
        },
        "InstanceAmount": {
          "Ref": "InstanceAmount"
        },
        "PrivatePoolOptions": {
          "Ref": "PrivatePoolOptions"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "StartTime": {
          "Ref": "StartTime"
        },
        "Period": {
          "Ref": "Period"
        },
        "InstanceTypes": {
          "Ref": "InstanceTypes"
        },
        "Tags": {
          "Ref": "Tags"
        },
        "PeriodUnit": {
          "Ref": "PeriodUnit"
        }
      }
    }
  },
  "Outputs": {
    "PrivatePoolOptionsId": {
      "Description": "キャパシティ予約の ID。",
      "Value": {
        "Fn::GetAtt": [
          "ElasticityAssurance",
          "PrivatePoolOptionsId"
        ]
      }
    }
  }
}