語法

{
  "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：待清理資源的詳細信息。取值為dict的列表，dict包含以下字段：

  字段	類型	說明
  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	資源的刪除依賴。取值為dict的列表，dict包含以下字段： ResourceType：依賴資源的資源類型。 RegionId：依賴資源的地域ID。 ResourceId：依賴資源的ID。

• ResourcePartialDetails：簡化版本ResourceDetails，只包含ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、ResourceStatusReason字段。

• NoCleanupResourceDetails：掃描過但不進行清理的資源詳情。格式與ResourceDetails相同。

• NoCleanupResourcePartialDetails：簡化版本NoCleanupResourceDetails，只包含ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、ResourceStatusReason字段。

• ResourceSummary：要清理的資源的摘要信息。取值為dict的列表，dict包含以下字段：

  字段	類型	說明
  ResourceType	String	資源類型。
  DeletingCount	Integer	刪除中的資源數量。
  SuccessCount	Integer	刪除成功的資源數量。
  FailureCount	Integer	刪除失敗的資源數量。
  SkippedCount	Integer	跳過刪除的資源數量。
  PendingCount	Integer	待刪除的資源數量。
  OtherCount	Integer	其他狀態的資源數量。
  TotalCount	Integer	資源的總數量。

• ScanErrors：掃描錯誤。僅在Mode為Loose時返回。取值為dict的列表，dict包含以下字段：

  字段	類型	說明
  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": {
    }
  }