ALIYUN::ROS::ResourceCleaner - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::ROS::ResourceCleaner は、リソースクリーナーを作成するために使用されます。

クリーンアップできるリソースタイプ

説明

Resource Orchestration Service (ROS) は、クリーンアップできるその他のリソースタイプも引き続きサポートしています。GetFeatureDetails オペレーションを呼び出して、クリーンアップできるリソースをクエリできます。

Alibaba Cloud サービス	リソースタイプ
Application Configuration Management	ACM:Namespace
ActionTrail	ACTIONTRAIL:Trail
Application Load Balancer (ALB)	ALB:Acl ALB:HealthCheckTemplate ALB:LoadBalancer ALB:SecurityPolicy ALB:ServerGroup




API Gateway	ApiGateway:App ApiGateway:Group ApiGateway:Instance ApiGateway:LogConfig ApiGateway:Plugin ApiGateway:Signature ApiGateway:TrafficControl






Application Real-Time Monitoring Service (ARMS)	ARMS:AlertContact ARMS:AlertContactGroup ARMS:RetcodeApp


Service Mesh (ASM)	ASM:ServiceMesh
Certificate Management Service	CAS:Certificate
ApsaraDB MyBase	CDDC:DedicatedHostGroup
Alibaba Cloud CDN (CDN)	CDN:Domain
ApsaraDB for ClickHouse	ClickHouse:DBCluster
Elastic Cloud Phone (ECP)	CloudPhone:InstanceGroup
CloudMonitor	CMS:Contact CMS:ContactGroup CMS:MetricRuleTemplate CMS:MonitorGroup CMS:SiteMonitor




Container Service for Kubernetes (ACK)	CS:Cluster
Container Registry	CR:Instance
DataHub	DATAHUB:Project
Dynamic Route for CDN (DCDN)	DCDN:Domain
Apsara File Storage for HDFS	DFS:AccessGroup DFS:FileSystem
Apsara File Storage for HDFS	DFS:AccessGroup DFS:FileSystem
Direct Mail	DirectMail:Domain DirectMail:Ipfilter
Direct Mail	DirectMail:Domain DirectMail:Ipfilter
Alibaba Cloud DNS (DNS)	DNS:Domain DNS:DomainGroup
Alibaba Cloud DNS (DNS)	DNS:Domain DNS:DomainGroup
PolarDB-X 1.0	DRDS:DrdsInstance
Elastic Container Instance	ECI:ContainerGroup ECI:ImageCache
Elastic Container Instance	ECI:ContainerGroup ECI:ImageCache
Elastic Compute Service (ECS)	ECS:AutoProvisioningGroup ECS:AutoSnapshotPolicy ECS:Command ECS:CustomImage ECS:DedicatedHost ECS:DeploymentSet ECS:Disk ECS:HpcCluster ECS:Instance ECS:LaunchTemplate ECS:NetworkInterface ECS:PrefixList ECS:SSHKeyPair ECS:SecurityGroup ECS:Snapshot
Virtual Private Cloud (VPC)	VPC:AnycastEIP VPC:CommonBandwidthPackage VPC:DhcpOptionsSet VPC:EIP VPC:EipSegment VPC:FlowLog VPC:HaVip VPC:Ipv6Gateway VPC:NatGateway VPC:NetworkAcl VPC:RouteTable VPC:VPC VPC:VSwitch
Resource Access Management (RAM)	RAM:Group RAM:ManagedPolicy RAM:Role RAM:SAMLProvider RAM:User
ApsaraDB RDS	RDS:DBInstance
ROS	ROS:Template
Server Load Balancer (SLB)	SLB:AccessControl SLB:Certificate SLB:LoadBalancer
Edge Node Service (ENS)	ENS:Instance
Auto Scaling	ESS:AlarmTask ESS:ScalingGroup ESS:ScheduledTask
Elastic Container Instance	ECI:ContainerGroup ECI:ImageCache
Serverless Workflow (SWF)	FNF:Flow
AnalyticDB for PostgreSQL	GPDB:DBInstance
Key Management Service (KMS)	KMS:Key KMS:Secret
ApsaraMQ for Kafka	KAFKA:Instance
ApsaraDB for MongoDB	MONGODB:Instance
ApsaraDB for Memcache (OCS)	Memcache:Instance
Microservices Engine (MSE)	MSE:Cluster MSE:Gateway
Message Service (MNS)	MNS:Topic MNS:Queue
ApsaraDB for Redis	REDIS:Instance
Log Service	SLS:Project
Function Compute	FC:Service
File Storage NAS (NAS)	NAS:AccessGroup NAS:FileSystem
Network Load Balancer (NLB)	NLB:LoadBalancer NLB:ServerGroup
Tablestore	OTS:Instance
Object Storage Service (OSS)	OSS:Bucket
CloudOps Orchestration Service (OOS)	OOS:Execution OOS:Template OOS:PatchBaseline OOS:Parameter OOS:SecretParameter
PolarDB	POLARDB:DBCluster
PrivateLink	PrivateLink:VpcEndpoint PrivateLink:VpcEndpointService
PolarDB-X 1.0	DRDS:DrdsInstance
ApsaraMQ for RocketMQ	ROCKETMQ:Instance
AnalyticDB for MySQL	ADB:DBCluster
Enterprise Distributed Application Service (EDAS)	EDAS:Application EDAS:Cluster
E-MapReduce (EMR)	EMR:Cluster
Elasticsearch	ElasticSearch:Instance
Hybrid Backup Recovery (HBR)	HBR:DBVault
Alibaba Cloud DNS PrivateZone	PVTZ:Zone
Serverless App Engine (SAE)	SAE:Application SAE:Namespace
Serverless App Engine (SAE)	SAE:Application SAE:Namespace
Smart Access Gateway (SAG)	SAG:ACL SAG:Qos
Time Series Database (TSDB)	TSDB:HiTSDBInstance
Web Application Firewall (WAF)	WAF:Domain

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Action	String	はい	はい	リソースクリーナーによって実行される操作。	有効な値： Scan：リソースをスキャンして、クリーンアップするリソースを取得します。 CleanUp：スキャン操作後に取得されたリソースをクリーンアップします。リソースクリーナーを作成するときは、Action を CleanUp に設定できません。リソースクリーナーを更新するときにのみ、Action を Action に設定できます。 Scan+CleanUp：リソースをスキャンし、リソースをクリーンアップします。 ScanWhenCreatingAndUpdating+CleanUpWhenDeleting：リソースクリーナーを作成または更新するときにリソースをスキャンし、リソースクリーナーを削除するときにリソースをクリーンアップします。
ResourceFilters	List	いいえ	はい	フィルターのリスト。リソースクリーナーはフィルターを使用して、クリーンアップするリソースをスキャンします。	最大 100 個のフィルターを指定できます。 ResourceFilters と Resources のいずれか 1 つのみを指定できます。リソースクリーナーを更新するときにフィルターが変更された場合、リソースクリーナーはスキャン操作を再開します。この場合、Action が CleanUp に設定されていると、クリーンアップ操作は失敗します。フィルターでは、Allow および Deny の効果がサポートされています。効果には次の値が有効です。値が小さいほど、優先順位が高くなります。 Deny タイプのフィルターのみに一致するリソースは保持されます。少なくとも Allow タイプのフィルターのみに一致するリソースはクリーンアップされます。詳細については、「ResourceFilters プロパティ」をご参照ください。
Resources	List	いいえ	はい	クリーンアップするリソースのリスト。	1 ～ 1,000 個のリソースを指定できます。 ResourceFilters と Resources のいずれか 1 つのみを指定できます。詳細については、「Resources プロパティ」をご参照ください。
Mode	String	いいえ	はい	リソースクリーナーの動作モード。	有効な値： Strict：リソースのスキャン失敗またはリソースのクリーンアップ失敗により、リソースクリーナーが失敗します。 Loose (デフォルト)：少数のリソースのスキャン失敗またはリソースのクリーンアップ失敗により、リソースクリーナーが失敗します。ほとんどのスキャン失敗は無視されます。失敗の詳細は、「出力」セクションの ScanErrors または ResourceDetails で確認できます。ほとんどのクリーンアップ失敗は無視されます。失敗の詳細は、「出力」セクションの ResourceDetails で確認できます。
FailureOption	String	いいえ	はい	リソースのクリーンアップに失敗した場合に依存関係が影響を受けるかどうかを決定するオプション。	有効な値： Normal (デフォルト)：リソースのクリーンアップに失敗した場合、依存関係に対するクリーンアップ操作は影響を受けません。 Fast：リソースのクリーンアップに失敗した場合、依存関係に対するクリーンアップ操作は実行されません。説明このオプションはクリーンアップ操作ではサポートされていますが、依存関係の作成操作ではサポートされていません。
CleanUpRetryCount	Integer	いいえ	はい	失敗したクリーンアップに許可される最大再試行回数。	有効な値：1 ～ 6。デフォルト値：1。値 1 は、クリーンアップ操作が再試行されないことを指定します。 1 以外の値を指定すると、次のいずれかの条件が満たされた場合にクリーンアップ操作が再試行されます。リソースのクリーンアップに失敗する。リソースのクリーンアップ操作がタイムアウトする。
CleanUpTimeout	Number	いいえ	はい	クリーンアップ操作に許可されるタイムアウト期間。	有効な値：60 ～ 14400。単位：秒。デフォルト値：3600。
ExcludedResources	List	いいえ	はい	クリーンアップするリソースから除外するリソースのリスト。	1 ～ 1000 個のリソースを指定できます。システムは、指定した各リスト項目に基づいて 1 つのリソースのみを除外します。リスト項目が複数のリソースにマッピングされている場合は、エラーが発生します。この場合、あいまいさを解消するために、リスト項目にさらにプロパティを指定する必要があります。詳細については、「ExcludedResources プロパティ」をご参照ください。
CleanUpAlgorithm	String	いいえ	はい	リソースのクリーンアップに使用するアルゴリズム。	有効な値： ResourceDependency (デフォルト)：依存関係の順序でリソースをクリーンアップします。 ResourceTypeOrder：リソースタイプの昇順でリソースをクリーンアップします。ResourceTypeOrder を使用して、リソースタイプの順序を指定できます。ResourceTypeOrder を空のままにすると、サポートされているすべてのリソースタイプがデフォルトの順序でソートされます。
ResourceTypeOrder	List	いいえ	はい	リソースタイプをクリーンアップする順序。	1 ～ 1000 個のリソースタイプを指定できます。このプロパティは、CleanUpAlgorithm が ResourceTypeOrder に設定されている場合に有効になります。システムは、リソースタイプが指定されていないリソースをスキャンまたはクリーンアップしません。サポートされているリソースタイプの詳細については、このトピックの「クリーンアップできるリソースタイプ」セクションをご参照ください。
DisabledSideEffects	List	いいえ	はい	無効にする副作用のリスト。	1 ～ 50 個の副作用を指定できます。リスト項目には、文字、数字、およびワイルドカード文字 (* および ?) を含めることができます。リスト項目の長さは 1 ～ 100 文字である必要があります。あいまい一致を実行するには、ワイルドカード文字としてアスタリスク (`*`) と疑問符 (`?`) のみを使用できます。クリーンアップ操作は、特定のリソースに副作用をもたらす可能性があります。GetFeatureDetails オペレーションを呼び出して、副作用をクエリできます。

ResourceFilters 構文

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

ResourceFilters プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
IncludeDeletionProtection	Boolean	いいえ	はい	削除保護が有効になっているリソースをフィルタリングするかどうかを指定します。	有効な値： false true (デフォルト)
ResourceTypePatterns	List	いいえ	はい	リソースのフィルタリングに使用するリソースタイプのリスト。あいまい一致がサポートされています。リソースタイプの詳細については、このトピックの「クリーンアップできるリソースタイプ」セクションをご参照ください。	1 ～ 100 個のリソースタイプを指定できます。リソースのリソースタイプが指定されたリソースタイプと一致する場合、リソースはフィルタリングされます。あいまい一致を実行するには、ワイルドカード文字としてアスタリスク (``) と疑問符 (`?`) のみを使用できます。リスト項目は、`Service:Type` 形式である必要があります。リスト項目の長さは 3 ～ 100 文字である必要があります。`Service` の値には、文字とワイルドカード文字 ( および ?) を含めることができます。`Type` の値には、文字、数字、およびワイルドカード文字 (* および ?) を含めることができます。
ResourceIds	List	いいえ	はい	リソースのフィルタリングに使用するリソース ID のリスト。	1 ～ 100 個のリソース ID を指定できます。リソースの ID が指定されたリソース ID と一致する場合、リソースはフィルタリングされます。リスト項目の長さは 1 ～ 256 文字である必要があります。
RegionIds	List	いいえ	はい	リソースのフィルタリングに使用するリージョン ID のリスト。	1 ～ 100 個のリージョン ID を指定できます。リソースのリージョン ID が指定されたリージョン ID と一致する場合、リソースはフィルタリングされます。リスト項目の長さは 1 ～ 64 文字である必要があります。
ResourceGroupIds	List	いいえ	はい	リソースのフィルタリングに使用するリソースグループのリスト。	1 ～ 100 個のリソースグループを指定できます。リソースのリソースグループが指定されたリソースグループと一致する場合、リソースはフィルタリングされます。リスト項目の長さは 1 ～ 256 文字である必要があります。
Effect	String	いいえ	はい	フィルタリングされたリソースへの影響。	有効な値： Deny：Deny タイプのフィルターのみに一致するリソースは保持されます。 Allow：Allow タイプのフィルターのみに一致するリソースはクリーンアップされます。説明リソースが Allow タイプと Deny タイプのフィルターに一致する場合、リソースは保持されます。
ResourceNamePatterns	List	いいえ	はい	リソースのフィルタリングに使用するリソース名のリスト。あいまい一致がサポートされています。	1 ～ 100 個のリソース名を指定できます。リソースの名前が指定されたリソース名と一致する場合、リソースはフィルタリングされます。あいまい一致を実行するには、ワイルドカード文字としてアスタリスク (``) と疑問符 (`?`) のみを使用できます。リソース名には、文字、数字、スペース、アンダースコア (`_`)、ハイフン (`-`)、およびワイルドカード文字 ( および ?) のみを含めることができます。リスト項目の長さは 1 ～ 100 文字である必要があります。
Tags	List	いいえ	はい	リソースのフィルタリングに使用するタグのリスト。カスタムタグとシステムタグがサポートされています。	1 ～ 100 個のタグを指定できます。次のルールが適用されます。タグキーとタグ値を指定した場合、タグキーとタグ値が指定されたタグキーとタグ値に一致するリソースがフィルタリングされます。説明タグキーと複数のタグ値を指定した場合、タグキーが指定されたタグキーに一致し、タグ値が指定されたタグ値のいずれかに一致するリソースがフィルタリングされます。タグキーを指定してもタグ値を指定しない場合、タグキーが指定されたタグキーに一致するリソースがフィルタリングされます。複数のタグキーとタグ値を指定した場合、タグキーとタグ値が指定されたタグキーとタグ値に一致するリソースがフィルタリングされます。詳細については、「Tags プロパティ」をご参照ください。

Tags 構文

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

Tags プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	はい	タグの値。	タグ値の長さは最大 256 文字です。説明このプロパティを空のままにした場合と、値が空の文字列である場合では、異なる結果が返されます。
Key	String	はい	はい	タグのキー。	タグキーの長さは 1 ～ 256 文字である必要があります。

Resources 構文

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

Resources プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceId	String	はい	はい	クリーンアップするリソースの ID。	リソース ID の長さは 1 ～ 256 文字である必要があります。
ResourceType	String	はい	はい	クリーンアップするリソースのリソースタイプ。	詳細については、このトピックの「クリーンアップできるリソースタイプ」セクションをご参照ください。
RegionId	String	はい	はい	クリーンアップするリソースのリージョン ID。	リージョン ID の長さは 1 ～ 64 文字である必要があります。

ExcludedResources 構文

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

ExcludedResources プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ResourceId	String	はい	はい	除外するリソースの ID。	リソース ID の長さは 1 ～ 256 文字である必要があります。
ResourceType	String	いいえ	はい	除外するリソースのリソースタイプ。	詳細については、このトピックの「クリーンアップできるリソースタイプ」セクションをご参照ください。
RegionId	String	いいえ	はい	除外するリソースのリージョン ID。	リージョン ID の長さは 1 ～ 64 文字である必要があります。

戻り値

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：ResourceDetails の簡略版。ResourcePartialDetails は、ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、および ResourceStatusReason フィールドのみで構成されます。
NoCleanupResourceDetails：スキャンされたがクリーンアップされていないリソースの詳細。値の形式は、ResourceDetails の値の形式と同じです。
NoCleanupResourcePartialDetails：NoCleanupResourceDetails の簡略版。NoCleanupResourcePartialDetails は、ResourceType、RegionId、ResourceId、ResourceName、ResourceStatus、および ResourceStatusReason フィールドのみで構成されます。

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