Resource Orchestration Service:ALIYUN::ROS::ResourceCleaner

構文

{
  "Type": "ALIYUN::ROS::ResourceCleaner",
  "Properties": {
    "Action": String,
    "ResourceFilters": List,
    "Resources": List,
    "Mode": String,
    "FailureOption": String,
    "CleanUpRetryCount": Integer,
    "CleanUpTimeout": Number,
    "ExcludedResources": List,
    "CleanUpAlgorithm": String,
    "ResourceTypeOrder": List,
    "DisabledSideEffects": List
  }
}

プロパティ

ResourceFilters の構文

"ResourceFilters": [
  {
    "IncludeDeletionProtection": Boolean,
    "ResourceTypePatterns": List,
    "ResourceIds": List,
    "RegionIds": List,
    "ResourceGroupIds": List,
    "Effect": String,
    "ResourceNamePatterns": List,
    "Tags": List
  }
]

ResourceFilters のプロパティ

Tags の構文

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

Tags のプロパティ

Resources の構文

"Resources": [
  {
    "ResourceId": String,
    "ResourceType": String,
    "RegionId": String
  }
]

Resources のプロパティ

ExcludedResources の構文

"ExcludedResources": [
  {
    "ResourceId": String,
    "ResourceType": String,
    "RegionId": String
  }
]

ExcludedResources のプロパティ

戻り値

Fn::GetAtt

• ResourceDetails：クリーンアップするリソースの詳細です。値は、次のフィールドを持つ辞書のリストです：

  フィールド	型	説明
  ResourceType	String	リソースタイプです。
  RegionId	String	リソースのリージョン ID です。
  ResourceId	String	リソース ID です。
  ResourceName	String	リソース名です。
  CleanupType	String	リソースのクリーンアップタイプです。有効値： Normal：リソースは正常に削除できます。 DeleteWithInstance：リソースは、それが属するリソースと一緒に削除されます。それが属するリソースがフィルターまたは除外されている場合、削除が失敗する可能性があります。詳細については、CleanupTypeReasons をご参照ください。 UnableToDelete：リソースは削除できません。詳細については、CleanupTypeReasons をご参照ください。
  CleanupTypeReasons	List	リソースのクリーンアップタイプの理由のリストです。
  ResourceStatus	String	リソースのステータスです。有効値： Deleting：リソースは削除中です。 Failure：リソースの削除に失敗しました。 Success：リソースは削除されました。 Skipped：リソースの削除はスキップされました。 Pending：リソースは削除待ちです。
  ResourceStatusReason	String	リソースステータスの理由です。
  Dependencies	List	リソースの削除依存関係です。値は、次のフィールドを持つ辞書のリストです： ResourceType：依存リソースのリソースタイプです。 RegionId：依存リソースのリージョン ID です。 ResourceId：依存リソースの ID です。

• ResourcePartialDetails：ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、および ResourceStatusReason フィールドのみを含む、ResourceDetails の簡易版です。

• NoCleanupResourceDetails：スキャンされたがクリーンアップされなかったリソースの詳細です。フォーマットは ResourceDetails と同じです。

• NoCleanupResourcePartialDetails：ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、および ResourceStatusReason フィールドのみを含む、NoCleanupResourceDetails の簡易版です。

• ResourceSummary：クリーンアップするリソースの概要です。値は、次のフィールドを持つ辞書のリストです：

  フィールド	型	説明
  ResourceType	String	リソースタイプです。
  DeletingCount	Integer	削除中のリソースの数です。
  SuccessCount	Integer	削除されたリソースの数です。
  FailureCount	Integer	削除に失敗したリソースの数です。
  SkippedCount	Integer	削除がスキップされたリソースの数です。
  PendingCount	Integer	削除待ちのリソースの数です。
  OtherCount	Integer	その他の状態のリソース数。
  TotalCount	Integer	リソースの総数です。

• ScanErrors：スキャン中に発生したエラーです。このパラメーターは、Mode が Loose に設定されている場合にのみ返されます。値は、次のフィールドを持つ辞書のリストです：

  フィールド	型	説明
  ResourceType	String	リソースタイプです。
  RegionId	String	リージョン ID です。
  ErrorMessage	String	指定されたリージョンとリソースタイプのスキャンのエラーメッセージです。

• CleanResult：全体的なクリーンアップ結果です。有効値：

  • Success：すべてのリソースがクリーンアップされました。

  • ResourceFailure：一部のリソースのクリーンアップに失敗しました。

  • Timeout：クリーンアップがタイムアウトしました。

  • CheckFailure：クリーンアップの事前チェックに失敗しました。

  • UnknownFailure：不明なエラーが発生しました。

  • UserCancelled：操作はユーザーによってキャンセルされました。

  • None：クリーンアップはトリガーされませんでした。

例

• YAML フォーマット

  ROSTemplateFormatVersion: '2015-09-01'
  Parameters: {}
  Resources:
    ResourceCleaner:
      Type: ALIYUN::ROS::ResourceCleaner
      Properties:
        FailureOption: Normal
        Action: Scan
        ResourceFilters:
          - ResourceIds:
              - i-bp1h09ipy0atb4kq****
        CleanUpRetryCount: 1
        CleanUpTimeout: 3600
        ExcludedResources:
          - ResourceId: i-bp1h09ipy0atb4kq****
            ResourceType: ECS:Instance
  Outputs: {}

• JSON フォーマット

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Parameters": {
    },
    "Resources": {
      "ResourceCleaner": {
        "Type": "ALIYUN::ROS::ResourceCleaner",
        "Properties": {
          "FailureOption": "Normal",
          "Action": "Scan",
          "ResourceFilters": [
            {
              "ResourceIds": [
                "i-bp1h09ipy0atb4kq****"
              ]
            }
          ],
          "CleanUpRetryCount": 1,
          "CleanUpTimeout": 3600,
          "ExcludedResources": [
            {
              "ResourceId": "i-bp1h09ipy0atb4kq****",
              "ResourceType": "ECS:Instance"
            }
          ]
        }
      }
    },
    "Outputs": {
    }
  }