すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::OOS::StateConfiguration

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::OOS::StateConfiguration

    最終更新日:Mar 17, 2025

    ALIYUN::OOS::StateConfiguration は、目標状態の構成を作成するために使用されます。

    構文

    {
  "Type": "ALIYUN::OOS::StateConfiguration",
  "Properties": {
    "ConfigureMode": String,
    "ScheduleExpression": String,
    "ScheduleType": String,
    "Description": String,
    "Parameters": String,
    "ResourceGroupId": String,
    "TemplateName": String,
    "TemplateVersion": String,
    "Targets": String,
    "Tags": Map
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ConfigureMode

    String

    いいえ

    はい

    構成モード。

    有効な値：

    • ApplyOnce：構成を 1 回だけ適用します。元の構成が更新された後に、構成が適用されます。

    • ApplyAndMonitor：構成を 1 回だけ適用します。構成が適用された後、システムは構成のドリフトのみをチェックします。

    • ApplyAndAutoCorrect：構成を常に適用します。

    ScheduleExpression

    String

    はい

    はい

    スケジュール式。

    2 つのスケジュール間の間隔は、30 分以上にする必要があります。

    ScheduleType

    String

    はい

    はい

    スケジュールの種類。

    値を rate に設定します。

    Description

    String

    いいえ

    はい

    目標状態の構成の説明。

    なし。

    Parameters

    String

    いいえ

    はい

    パラメーター。

    例：

    { "policy": { "ACS:Application": { "Collection": "Enabled" }, "ACS:Network": { "Collection": "Enabled" } } }

    ResourceGroupId

    String

    いいえ

    はい

    リソース グループ の ID。

    なし。

    TemplateName

    String

    はい

    いいえ

    テンプレート名。

    名前は最大 200 文字で、文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。

    TemplateVersion

    String

    いいえ

    いいえ

    バージョン番号。

    このプロパティを指定しない場合、デフォルトで最新バージョンが使用されます。

    Targets

    String

    はい

    はい

    クエリ対象のリソース。

    なし。

    Tags

    Map

    いいえ

    はい

    タグ。

    タグには最大 20 個のキーを含めることができます。タグの例：

    {"Key": "oos", "Value": "inventory"}

    戻り値

    Fn::GetAtt

    StateConfigurationId：作成された目標状態の構成の ID。

    例

    • YAML 形式

      ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ConfigureMode:
    Description:
      ja: '構成モード。有効な値：ApplyOnce：構成は 1 回だけ適用されます。構成が更新された後、新しい構成が適用されます。 ApplyAndMonitor：構成は 1 回だけ適用されます。構成が適用された後、システムは今後構成が移行されるかどうかのみをチェックします。 ApplyAndAutoCorrect：構成は常に適用されます。'
    Required: false
    Type: String
  Description:
    AssociationProperty: TextArea
    Description:
      ja: 目標状態の構成の説明。
    Required: false
    Type: String
  Parameters:
    Description:
      ja: パラメーター。
    Required: false
    Type: String
  ResourceGroupId:
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
    Description:
      ja: リソース グループ ID。
    Required: false
    Type: String
  ScheduleExpression:
    Description:
      ja: スケジュール式。2 つのスケジュール間の間隔は、最低 30 分にする必要があります。
    Required: true
    Type: String
  ScheduleType:
    Description:
      ja: スケジュールの種類。値を rate に設定します。
    Required: true
    Type: String
  Tags:
    Description:
      ja: タグ値とキー マッピング。キー番号のラベルは最大 20 個まで指定できます。
    Required: false
    Type: Json
  Targets:
    Description:
      ja: クエリ対象のリソース。
    Required: true
    Type: String
  TemplateName:
    Description:
      ja: テンプレートの名前。名前は 1 ～ 200 文字で、文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。
    Required: true
    Type: String
  TemplateVersion:
    Description:
      ja: テンプレートのバージョン番号。このパラメーターを指定しない場合、テンプレートの最新バージョンが使用されます。
    Required: false
    Type: String
Resources:
  StateConfiguration:
    Properties:
      ConfigureMode:
        Ref: ConfigureMode
      Description:
        Ref: Description
      Parameters:
        Ref: Parameters
      ResourceGroupId:
        Ref: ResourceGroupId
      ScheduleExpression:
        Ref: ScheduleExpression
      ScheduleType:
        Ref: ScheduleType
      Tags:
        Ref: Tags
      Targets:
        Ref: Targets
      TemplateName:
        Ref: TemplateName
      TemplateVersion:
        Ref: TemplateVersion
    Type: ALIYUN::OOS::StateConfiguration
Outputs:
  StateConfigurationId:
    Description: 目標状態の構成の ID。
    Value:
      Fn::GetAtt:
      - StateConfiguration
      - StateConfigurationId

    • JSON 形式

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ConfigureMode": {
      "Type": "String",
      "Description": {
        "ja": "構成モード。有効な値：ApplyOnce：構成は 1 回だけ適用されます。構成が更新された後、新しい構成が適用されます。 ApplyAndMonitor：構成は 1 回だけ適用されます。構成が適用された後、システムは今後構成が移行されるかどうかのみをチェックします。 ApplyAndAutoCorrect：構成は常に適用されます。"
      },
      "Required": false
    },
    "ScheduleExpression": {
      "Type": "String",
      "Description": {
        "ja": "スケジュール式。2 つのスケジュール間の間隔は、最低 30 分にする必要があります。"
      },
      "Required": true
    },
    "ScheduleType": {
      "Type": "String",
      "Description": {
        "ja": "スケジュールの種類。値を rate に設定します。"
      },
      "Required": true
    },
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "ja": "目標状態の構成の説明。"
      },
      "Required": false
    },
    "Parameters": {
      "Type": "String",
      "Description": {
        "ja": "パラメーター。"
      },
      "Required": false
    },
    "ResourceGroupId": {
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId",
      "Type": "String",
      "Description": {
        "ja": "リソース グループ ID。"
      },
      "Required": false
    },
    "TemplateName": {
      "Type": "String",
      "Description": {
        "ja": "テンプレートの名前。名前は 1 ～ 200 文字で、文字、数字、ハイフン（-）、およびアンダースコア（_）を含めることができます。"
      },
      "Required": true
    },
    "TemplateVersion": {
      "Type": "String",
      "Description": {
        "ja": "テンプレートのバージョン番号。このパラメーターを指定しない場合、テンプレートの最新バージョンが使用されます。"
      },
      "Required": false
    },
    "Targets": {
      "Type": "String",
      "Description": {
        "ja": "クエリ対象のリソース。"
      },
      "Required": true
    },
    "Tags": {
      "Type": "Json",
      "Description": {
        "ja": "タグ値とキー マッピング。キー番号のラベルは最大 20 個まで指定できます。"
      },
      "Required": false
    }
  },
  "Resources": {
    "StateConfiguration": {
      "Type": "ALIYUN::OOS::StateConfiguration",
      "Properties": {
        "ConfigureMode": {
          "Ref": "ConfigureMode"
        },
        "ScheduleExpression": {
          "Ref": "ScheduleExpression"
        },
        "ScheduleType": {
          "Ref": "ScheduleType"
        },
        "Description": {
          "Ref": "Description"
        },
        "Parameters": {
          "Ref": "Parameters"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "TemplateName": {
          "Ref": "TemplateName"
        },
        "TemplateVersion": {
          "Ref": "TemplateVersion"
        },
        "Targets": {
          "Ref": "Targets"
        },
        "Tags": {
          "Ref": "Tags"
        }
      }
    }
  },
  "Outputs": {
    "StateConfigurationId": {
      "Description": "目標状態の構成の ID。",
      "Value": {
        "Fn::GetAtt": [
          "StateConfiguration",
          "StateConfigurationId"
        ]
      }
    }
  }
}