Resource Orchestration Service:ALIYUN::ROS::ResourceCleaner

Syntax

{
  "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
  }
}

Properties

ResourceFilters syntax

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

ResourceFilters properties

Tags syntax

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

Tags properties

Resources syntax

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

Resources properties

ExcludedResources syntax

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

ExcludedResources properties

Return values

Fn::GetAtt

• ResourceDetails: The details of the resources to clean up. The value is a list of dictionaries with the following fields:

  Field	Type	Description
  ResourceType	String	The resource type.
  RegionId	String	The region ID of the resource.
  ResourceId	String	The resource ID.
  ResourceName	String	The resource name.
  CleanupType	String	The cleanup type of the resource. Valid values: Normal: The resource can be deleted normally. DeleteWithInstance: The resource is deleted along with the resource to which it belongs. If the resource to which it belongs is filtered or excluded, deletion may fail. See CleanupTypeReasons for details. UnableToDelete: The resource cannot be deleted. See CleanupTypeReasons for details.
  CleanupTypeReasons	List	A list of reasons for the resource cleanup type.
  ResourceStatus	String	The status of the resource. Valid values: Deleting: The resource is being deleted. Failure: The resource failed to be deleted. Success: The resource was deleted. Skipped: The resource deletion was skipped. Pending: The resource is pending deletion.
  ResourceStatusReason	String	The reason for the resource status.
  Dependencies	List	The deletion dependencies of the resource. The value is a list of dictionaries with the following fields: ResourceType: The resource type of the dependent resource. RegionId: The region ID of the dependent resource. ResourceId: The ID of the dependent resource.

• ResourcePartialDetails: A simplified version of ResourceDetails that includes only the ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus, and ResourceStatusReason fields.

• NoCleanupResourceDetails: The details of resources that are scanned but not cleaned up. The format is the same as ResourceDetails.

• NoCleanupResourcePartialDetails: A simplified version of NoCleanupResourceDetails that includes only the ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus, and ResourceStatusReason fields.

• ResourceSummary: A summary of the resources to clean up. The value is a list of dictionaries with the following fields:

  Field	Type	Description
  ResourceType	String	The resource type.
  DeletingCount	Integer	The number of resources being deleted.
  SuccessCount	Integer	The number of deleted resources.
  FailureCount	Integer	The number of resources that failed to be deleted.
  SkippedCount	Integer	The number of resources whose deletion was skipped.
  PendingCount	Integer	The number of resources pending deletion.
  OtherCount	Integer	The number of resources in other states.
  TotalCount	Integer	The total number of resources.

• ScanErrors: The errors that occurred during scanning. This parameter is returned only when Mode is set to Loose. The value is a list of dictionaries with the following fields:

  Field	Type	Description
  ResourceType	String	The resource type.
  RegionId	String	The region ID.
  ErrorMessage	String	The error message for the scan of the specified region and resource type.

• CleanResult: The overall cleanup result. Valid values:

  • Success: All resources were cleaned up.

  • ResourceFailure: The cleanup of some resources failed.

  • Timeout: The cleanup timed out.

  • CheckFailure: The cleanup precheck failed.

  • UnknownFailure: An unknown error occurred.

  • UserCancelled: The operation was canceled by the user.

  • None: No cleanup was triggered.

Examples

• YAML format

  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 format

  {
    "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": {
    }
  }