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：待清理资源的详细信息。取值为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": {
    }
  }