リソースプランを作成するための ALIYUN::BSS::ResourcePackage の使用方法 - Resource Orchestration Service

ALIYUN::BSS::ResourcePackage は、リソースプランを作成するために使用されます。

構文

{
  "Type": "ALIYUN::BSS::ResourcePackage",
  "Properties": {
    "ProductCode": String, // サービスコード
    "PricingCycle": String, // 課金周期
    "PackageType": String, // パッケージタイプ
    "Specification": String, // 仕様
    "Duration": Integer, // 有効期間
    "EffectiveDate": String, // 発効日
    "AutoRenewPeriod": Integer, // 自動更新期間
    "AutoRenew": Boolean, // 自動更新
    "AutoRenewPeriodUnit": String // 自動更新期間単位
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Duration	Integer	はい	いいえ	リソースプランの有効期間。	DescribeResourcePackageProduct 操作を呼び出し、AvailableDuration 内の Value パラメーターの値を確認して、有効期間をクエリできます。
PackageType	String	はい	いいえ	リソースプランのタイプ。	DescribeResourcePackageProduct 操作を呼び出し、ResourcePackage 内の Code パラメーターの値を確認して、リソースプランのタイプをクエリできます。
ProductCode	String	はい	いいえ	サービスコード。	QueryProductList 操作を呼び出して、サービスコードをクエリできます。
Specification	String	はい	いいえ	リソースプランの仕様。	DescribeResourcePackageProduct 操作を呼び出し、Specification 内の Value パラメーターの値を確認して、仕様をクエリできます。説明 `DescribeResourcePackageProduct` 操作は、`ProductCode` パラメーターで指定されたサービスコードに対応するすべてのリソースプランタイプを返します。リソースプランの仕様をクエリする場合は、操作で `PackageType` パラメーターで指定されたリソースプランタイプに対応する `Code` 値を確認してください。
AutoRenewPeriod	Integer	いいえ	はい	自動更新期間。	単位：月。有効な値：1、2、3、および 6。
AutoRenew	Boolean	いいえ	はい	自動更新を有効にするかどうかを指定します。	有効な値： true false (デフォルト)
AutoRenewPeriodUnit	String	いいえ	はい	自動更新期間の単位。	有効な値： Month Year
EffectiveDate	String	いいえ	いいえ	リソースプランが有効になる時点。	このプロパティを指定しない場合、リソースプランはリソースプランの作成時に有効になります。 ISO 8601 標準の `yyyy-MM-ddTHH:mm:ssZ` 形式で時間を指定します。時間は UTC でなければなりません。
PricingCycle	String	いいえ	いいえ	リソースプランの有効期間の単位。	有効な値： Month (デフォルト) Year

戻り値

Fn::GetAtt

InstanceId: リソースプランの ID。
OrderId: 注文の ID。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ProductCode:
    Type: String
    Description: 指定した製品のコード。値は、QueryProductList によって返される ProductType の値と同じです。
    Default: ossbag
  PricingCycle:
    Type: String
    Description: '指定したリソースパッケージの有効期間。デフォルト値：Month。有効な値：Month、Year'
    AllowedValues:
      - Month
      - Year
    Default: Month
  PackageType:
    Type: String
    Description: 指定したリソースパッケージのタイプ。値は、DescribeResourcePackageProduct によって返される ResourcePackage オブジェクトの Code 値と同じです。
    Default: FPT_ossbag_deadlineAcc_CdnOut_china_common
  Specification:
    Type: String
    Description: 指定したリソースパッケージのサイズ。値は、DescribeResourcePackageProduct によって返される Specification の Value と同じです。
    Default: '1024'
  Duration:
    Type: Number
    Description: 指定したリソースパッケージの有効期間。値は、DescribeResourcePackageProduct によって返される AvailableDuration の Value と同じです。
    Default: 6
  EffectiveDate:
    Type: String
    Description: '指定したリソースパッケージの発効日。発効日が指定されていない場合、リソースパッケージはすぐに有効になります。日付形式は ISO8601 標準に従い、UTC 時間を使用します。形式：yyyy-MM-ddTHH:mm:ssZ'
    Default: '2021-12-03T12:00:00Z'
Resources:
  ResourcePackage:
    Type: ALIYUN::BSS::ResourcePackage
    Properties:
      ProductCode:
        Ref: ProductCode
      PricingCycle:
        Ref: PricingCycle
      PackageType:
        Ref: PackageType
      Specification:
        Ref: Specification
      Duration:
        Ref: Duration
      EffectiveDate:
        Ref: EffectiveDate
Outputs:
  InstanceId:
    Description: 指定したインスタンスの ID。
    Value:
      Fn::GetAtt:
        - ResourcePackage
        - InstanceId
  OrderId:
    Description: 指定した注文の ID。
    Value:
      Fn::GetAtt:
        - ResourcePackage
        - OrderId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ProductCode": {
      "Type": "String",
      "Description": "指定した製品のコード。値は、QueryProductList によって返される ProductType の値と同じです。", // 指定した製品のコード。値は QueryProductList から返される ProductType の値と同じです。
      "Default": "ossbag"
    },
    "PricingCycle": {
      "Type": "String",
      "Description": "指定したリソースパッケージの有効期間。デフォルト値：Month。有効な値：Month、Year", // 指定したリソースパッケージの有効期間。デフォルト値は Month です。有効な値：Month、Year
      "AllowedValues": [
        "Month",
        "Year"
      ],
      "Default": "Month"
    },
    "PackageType": {
      "Type": "String",
      "Description": "指定したリソースパッケージのタイプ。値は、DescribeResourcePackageProduct によって返される ResourcePackage オブジェクトの Code 値と同じです。", // 指定したリソースパッケージのタイプ。値は DescribeResourcePackageProduct から返される ResourcePackage オブジェクトの Code 値と同じです。
      "Default": "FPT_ossbag_deadlineAcc_CdnOut_china_common"
    },
    "Specification": {
      "Type": "String",
      "Description": "指定したリソースパッケージのサイズ。値は、DescribeResourcePackageProduct によって返される Specification の Value と同じです。", // 指定したリソースパッケージのサイズ。値は DescribeResourcePackageProduct から返される Specification の Value と同じです。
      "Default": "1024"
    },
    "Duration": {
      "Type": "Number",
      "Description": "指定したリソースパッケージの有効期間。値は、DescribeResourcePackageProduct によって返される AvailableDuration の Value と同じです。", // 指定したリソースパッケージの有効期間。値は DescribeResourcePackageProduct から返される AvailableDuration の Value と同じです。
      "Default": 6
    },
    "EffectiveDate": {
      "Type": "String",
      "Description": "指定したリソースパッケージの発効日。発効日が指定されていない場合、リソースパッケージはすぐに有効になります。日付形式は ISO8601 標準に従い、UTC 時間を使用します。形式：yyyy-MM-ddTHH:mm:ssZ", // 指定したリソースパッケージの発効日。発効日が指定されていない場合、リソースパッケージはすぐに有効になります。日付形式は ISO8601 標準 (yyyy-MM-ddTHH:mm:ssZ) に従い、UTC 時間を使用します。
      "Default": "2021-12-03T12:00:00Z"
    }
  },
  "Resources": {
    "ResourcePackage": {
      "Type": "ALIYUN::BSS::ResourcePackage",
      "Properties": {
        "ProductCode": {
          "Ref": "ProductCode"
        },
        "PricingCycle": {
          "Ref": "PricingCycle"
        },
        "PackageType": {
          "Ref": "PackageType"
        },
        "Specification": {
          "Ref": "Specification"
        },
        "Duration": {
          "Ref": "Duration"
        },
        "EffectiveDate": {
          "Ref": "EffectiveDate"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "指定したインスタンスの ID。", // 指定したインスタンスの ID
      "Value": {
        "Fn::GetAtt": [
          "ResourcePackage",
          "InstanceId"
        ]
      }
    },
    "OrderId": {
      "Description": "指定した注文の ID。", // 指定した注文の ID
      "Value": {
        "Fn::GetAtt": [
          "ResourcePackage",
          "OrderId"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`JSON` 形式