cdk gc - AWS 클라우드 개발 키트(AWS CDK) v2
사용법인수옵션예제

CDK AWS v2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔으며 2023년 6월 1일에 지원이 종료되었습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

cdk gc

AWS Cloud Development Kit(AWS CDK) 명령줄 인터페이스(CLI) cdk gc 명령을 사용하여 부트스트랩 스택의 리소스에 저장된 미사용 자산에 대한 폐영역 회수를 수행합니다. 더 이상 필요하지 않은 자산을 확인, 관리 및 삭제하려면 이 명령을 사용합니다.

Amazon Simple Storage Service(Amazon S3) 자산의 경우 CDK CLI는 동일한 환경의 기존 AWS CloudFormation 템플릿을 확인하여 참조되는지 확인합니다. 참조하지 않으면 사용되지 않은 것으로 간주되며 폐영역 회수 작업에 적합한 것으로 간주됩니다.

주의

cdk gc 명령은 AWS CDK용으로 개발 중입니다. 이 명령의 현재 기능은 프로덕션에 적합하고 사용하기에 안전한 것으로 간주됩니다. 그러나 이 명령의 범위와 기능은 변경될 수 있습니다. 따라서 이 명령을 사용할 수 있는 unstable=gc 옵션을 제공하여 옵트인해야 합니다.

사용법

$ cdk gc <arguments> <options>

인수

AWS 환경

폐영역 회수 작업을 수행할 대상 AWS 환경입니다.

환경을 제공할 때 사용할 형식: aws://<account-id>/<region> 예를 들어 aws://<123456789012>/<us-east-1>입니다.

이 인수는 단일 명령으로 여러 번 제공하여 여러 환경에서 폐영역 회수 작업을 수행할 수 있습니다.

기본적으로 CDK CLI는 CDK 앱에서 참조하거나 인수로 제공하는 모든 환경에서 폐영역 회수 작업을 수행합니다. 환경을 제공하지 않으면 CDK CLI가 기본 소스에서 환경을 결정합니다. 이러한 소스에는 --profile 옵션, 환경 변수 또는 기본 AWS CLI 소스를 사용하여 지정하는 환경이 포함됩니다.

옵션

모든 CDK CLI 명령에서 작동하는 글로벌 옵션 목록은 글로벌 옵션을 참조하세요.

--action <STRING>

폐영역 회수 과정에서 cdk gc가 자산에 대해 수행하는 작업입니다.

  • delete-tagged - 제공한 버퍼 일수 범위 내의 날짜로 태그가 지정되었지만 새로 식별된 미사용 자산에는 태그가 지정되지 않은 자산을 삭제합니다.

  • full - 모든 폐영역 회수 작업을 수행합니다. 여기에는 제공한 버퍼 일수 범위 내의 자산을 삭제하고 새로 식별된 미사용 자산에 태그를 지정하는 것이 포함됩니다.

  • print - 명령 프롬프트에서 미사용 자산 수를 출력하지만 AWS 환경 내에서 실제로 변경하지는 않습니다.

  • tag - 새로 식별된 미사용 자산에 태그를 지정하지만, 사용자가 제공한 버퍼 일수 범위 내의 자산은 삭제하지 않습니다.

허용되는 값: delete-tagged, full, print, tag

기본 값: full

--bootstrap-stack-name <STRING>

사용자의 AWS 환경에서 CDK 부트스트랩 스택의 이름입니다. 부트스트랩 스택 이름을 사용자 지정한 경우 이 옵션을 제공합니다. 기본 CDKToolkit 스택 이름을 사용하는 경우 해당 옵션을 제공할 필요가 없습니다.

기본 값: CDKToolkit

--confirm <BOOLEAN>

자산을 삭제하기 전에 CDK CLI가 수동 확인을 요청할지 여부를 지정합니다.

수동 확인 메시지를 표시하지 않고 자산을 자동으로 삭제하려면 false를 지정합니다.

기본 값: true

--created-buffer-days <NUMBER>

자산이 폐영역 회수 작업에 적합하기 전에 존재해야 하는 일수입니다.

숫자를 입력하면 지정된 일수를 초과하여 존재하지 않은 자산이 폐영역 회수 작업에서 필터링됩니다.

기본 값: 1

--help, -h <BOOLEAN>

cdk gc 명령에 대한 명령 참조 정보를 표시합니다.

--rollback-buffer-days <NUMBER>

자산이 폐영역 회수 작업에 적합하기 전에 격리 대상으로 태그 되어야 하는 일수입니다.

숫자를 입력하면 CDK CLI는 미사용 자산을 삭제하는 대신 현재 날짜로 태그를 지정합니다. 또한 CDK CLI는 cdk gc 명령의 이전 실행 중에 태그가 지정된 자산이 있는지 확인합니다. 이전에 태그가 지정된 자산 중 사용자가 제공한 버퍼 일수 범위에 속하는 자산은 삭제됩니다.

기본 값: 0

--type <STRING>

폐영역 회수 작업을 수행할 부트스트랩 스택 내의 부트스트랩 리소스 유형입니다.

  • all - 부트스트랩된 모든 리소스에 대해 폐영역 회수 작업을 수행합니다.

  • ecr - 부트스트랩 스택의 Amazon Elastic Container Registry(Amazon ECR) 리포지토리에 있는 자산에 대해 폐영역 회수 작업을 수행합니다.

  • s3 - 부트스트랩 스택의 Amazon S3 버킷에 있는 자산에 대해 폐영역 회수 작업을 수행합니다.

허용되는 값: all, ecr, s3

기본 값: all

--unstable <STRING>

아직 개발 중인 CDK CLI 명령의 사용을 허용합니다.

이 옵션은 아직 개발 중이며 변경될 수 있는 CDK CLI 명령을 사용하는 데 필요합니다.

이 옵션은 단일 명령에서 여러 번 제공할 수 있습니다.

cdk gc를 사용하려면 --unstable=gc를 제공합니다.

예제

기본 예제

다음 예제에서는 부트스트랩 스택의 Amazon S3 버킷에 있는 자산에 대해 기본 폐영역 회수 작업을 수행하기 위한 수동 확인을 요청합니다.

$ cdk gc --unstable=gc --type=s3

 ⏳  Garbage Collecting environment aws://<account-id>/<region>...
Found 99 assets to delete based off of the following criteria:
- assets have been isolated for > 0 days
- assets were created > 1 days ago

Delete this batch (yes/no/delete-all)?

다음 예제에서는 부트스트랩 스택의 Amazon S3 버킷에 있는 자산 범위에 대해 폐영역 회수 작업을 수행합니다. 이 범위에는 cdk gc가 이전에 30일 이상 태그 지정했고 10일 이전에 생성된 자산이 포함됩니다. 이 명령은 자산을 삭제하기 전에 수동 확인을 묻는 메시지를 표시합니다.

$ cdk gc --unstable=gc --type=s3 --rollback-buffer-days=30 --created-buffer-days=10

다음 예제에서는 30일 이상 사용되지 않은 부트스트랩 스택의 Amazon S3 버킷에서 이전에 태그가 지정된 자산을 삭제하는 작업을 수행합니다.

$ cdk gc --unstable=gc --type=s3 --action=delete-tagged --rollback-buffer-days=30