AWS CDK CLI 명령 참조

RSS

포커스 모드

AWS CDK CLI 명령 참조 - AWS Cloud Development Kit (AWS CDK) v2

사용법 명령 글로벌 옵션 옵션 제공 및 구성 명령줄에서 옵션 전달

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

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

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

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

이 섹션에는 명령줄 인터페이스()에 대한 AWS Cloud Development Kit (AWS CDK) 명령 참조 정보가 포함되어 있습니다CLI. CDK CLI는 CDK Toolkit라고도 합니다.

사용법


$ cdk <command> <arguments> <options>

명령

acknowledge, ack: 문제 번호로 공지를 확인하고 다시 표시되지 않도록 숨깁니다.
bootstrap: 라는 CDK 부트스트랩 스택을 AWS 환경에 배포하여 CDK 배포CDKToolkit를 위한 AWS 환경을 준비합니다.
context: CDK 애플리케이션의 캐시된 컨텍스트 값을 관리합니다.
deploy: AWS 환경에 CDK 스택을 하나 이상 배포합니다.
destroy: AWS 환경에서 하나 이상의 CDK 스택을 삭제합니다.
diff: diff를 수행하여 CDK 스택 간의 인프라 변경 사항을 확인합니다.
docs, doc: 브라우저에서 CDK 설명서를 엽니다.
doctor: 로컬 CDK 프로젝트와 개발 환경에 대한 유용한 정보를 검사하고 표시합니다.
import: AWS CloudFormation 리소스 가져오기를 사용하여 기존 AWS 리소스를 CDK 스택으로 가져옵니다.
init: 템플릿에서 새 CDK 프로젝트를 생성합니다.
list, ls: CDK 앱의 모든 CDK 스택과 해당 종속성을 나열합니다.
metadata: CDK 스택과 연결된 메타데이터를 표시합니다.
migrate: AWS 리소스, AWS CloudFormation 스택 및 AWS CloudFormation 템플릿을 새 CDK 프로젝트로 마이그레이션합니다.
notices: CDK 애플리케이션에 대한 공지를 표시합니다.
synthesize, synth: CDK 앱을 합성하여 각 스택에 대한 AWS CloudFormation 템플릿을 포함한 클라우드 어셈블리를 생성합니다.
watch: 로컬 CDK 프로젝트를 지속적으로 감시하여 배포와 핫스왑을 수행할 변경 사항이 있는지 확인합니다.

글로벌 옵션

다음 옵션은 모든 CDK CLI 명령과 호환됩니다.

--app, -a STRING

앱 또는 클라우드 어셈블리 디렉터리를 실행하기 위한 명령을 제공합니다.

필수 항목 여부: 예

--asset-metadata BOOLEAN

자산을 사용하는 리소스에 대한 aws:asset:* AWS CloudFormation 메타데이터를 포함합니다.

필수 항목 여부: 아니요

기본값: true

--build STRING

사전 합성 빌드를 실행하기 위한 명령입니다.

필수 항목 여부: 아니요

--ca-bundle-path STRING

HTTPS 요청을 검증할 때 사용할 CA 인증서의 경로입니다.

이 옵션이 제공되지 않으면 CDK CLI가 AWS_CA_BUNDLE 환경 변수에서 읽습니다.

필수 항목 여부: 예

--ci BOOLEAN

CDK CLI 명령이 지속적 통합(CI) 환경에서 실행되고 있음을 나타냅니다.

이 옵션은 CI 파이프라인에서 일반적으로 사용되는 자동화 작업에 더 적합하도록 CDK CLI의 동작을 수정합니다.

이 옵션을 제공하면 로그가 stderr 대신 stdout으로 전송됩니다.

필수 항목 여부: 아니요

기본값: false

--context, -c ARRAY

컨텍스트 문자열 파라미터를 키 값 페어로 추가합니다.

--debug BOOLEAN

세부 디버깅 정보를 활성화합니다. 이 옵션은 CDK CLI가 백그라운드에서 수행하는 작업에 대한 훨씬 더 자세한 정보를 포함하는 자세한 출력을 생성합니다.

필수 항목 여부: 아니요

기본값: false

--ec2creds, -i BOOLEAN

CDK CLI가 Amazon EC2 인스턴스 자격 증명을 가져오도록 강제합니다.

기본적으로 CDK CLI는 Amazon EC2 인스턴스 상태를 추측합니다.

필수 항목 여부: 아니요

기본값: false

--help, -h BOOLEAN

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

필수 항목 여부: 아니요

기본값: false

--ignore-errors BOOLEAN

유효하지 않은 출력을 생성할 가능성이 있는 합성 오류는 무시합니다.

필수 항목 여부: 아니요

기본값: false

--json, -j BOOLEAN

표준 출력()에 인쇄되는 AWS CloudFormation 템플릿에는 YAML 대신 JSON을 사용합니다stdout.

필수 항목 여부: 아니요

기본값: false

--lookups BOOLEAN

컨텍스트 조회를 수행합니다.

이 값이 false이고 컨텍스트 조회를 수행해야 하는 경우 합성이 실패합니다.

필수 항목 여부: 아니요

기본값: true

--no-color BOOLEAN

콘솔 출력에서 색상과 기타 스타일링을 제거합니다.

필수 항목 여부: 아니요

기본값: false

--notices BOOLEAN

관련 공지를 표시합니다.

필수 항목 여부: 아니요

기본값: false

--output, -o STRING

합성된 클라우드 어셈블리를 출력할 디렉터리를 지정합니다.

필수 항목 여부: 예

기본값: cdk.out

--path-metadata BOOLEAN

각 리소스에 대한 aws::cdk::path AWS CloudFormation 메타데이터를 포함합니다.

필수 항목 여부: 아니요

기본값: true

--plugin, -p ARRAY

CDK 기능을 확장하는 node 패키지의 이름 또는 경로입니다. 이 옵션은 단일 명령에서 여러 번 제공할 수 있습니다.

프로젝트의 cdk.json 파일이나 로컬 개발 시스템의 ~/.cdk.json에서 이 옵션을 구성할 수 있습니다.


{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

필수 항목 여부: 아니요

--profile STRING

CDK에 사용할 AWS 환경 정보가 포함된 AWS 프로파일의 이름을 지정합니다CLI.

필수 항목 여부: 예

--proxy STRING

표시된 프록시를 사용합니다.

이 옵션이 제공되지 않으면 CDK CLI가 HTTPS_PROXY 환경 변수에서 읽습니다.

필수 항목 여부: 예

기본값: HTTPS_PROXY 환경 변수에서 읽습니다.

--role-arn, -r STRING

CDK가 상호 작용할 때 CLI 수임할 IAM 역할의 ARN입니다 AWS CloudFormation.

필수 항목 여부: 아니요

--staging BOOLEAN

자산을 출력 디렉터리에 복사합니다.

출력 디렉터리에 자산이 복사되지 않도록 false를 지정합니다. 이렇게 하면가 AWS SAM 로컬 디버깅을 수행할 때 원본 소스 파일을 참조CLI할 수 있습니다.

필수 항목 여부: 아니요

기본값: true

--strict BOOLEAN

경고가 포함된 스택을 생성하지 않습니다.

필수 항목 여부: 아니요

기본값: false

--trace BOOLEAN

스택 경고에 대한 트레이스를 출력합니다.

필수 항목 여부: 아니요

기본값: false

--verbose, -v COUNT

디버그 로그를 표시합니다. 이 옵션을 여러 번 지정하여 상세 수준을 높일 수 있습니다.

필수 항목 여부: 아니요

--version BOOLEAN

CDK CLI 버전 번호를 표시합니다.

필수 항목 여부: 아니요

기본값: false

--version-reporting BOOLEAN

합성된 AWS CloudFormation 템플릿에 AWS::CDK::Metadata 리소스를 포함합니다.

필수 항목 여부: 아니요

기본값: true

옵션 제공 및 구성

명령줄 인수를 통해 옵션을 전달할 수 있습니다. 대부분 옵션의 경우 cdk.json 구성 파일에서 구성할 수 있습니다. 여러 구성 소스를 사용하는 경우 CDK CLI는 다음 우선순위를 따릅니다.

명령줄 값 - 명령줄에 제공된 모든 옵션은 cdk.json 파일에 구성된 옵션을 재정의합니다.
프로젝트 구성 파일 - CDK 프로젝트의 디렉터리에 있는 cdk.json 파일입니다.
사용자 구성 파일 - 로컬 시스템의 ~/.cdk.json에 있는 cdk.json 파일입니다.

명령줄에서 옵션 전달

부울 값 전달

부울 값을 수락하는 옵션에 대해 다음과 같은 방법으로 지정할 수 있습니다.

true 및 false 값 사용 - 명령과 함께 부울 값을 제공합니다. 다음은 예제입니다.
```
$ cdk deploy --watch=true
$ cdk deploy --watch=false
```
옵션의 대응 항목 제공 - false 값을 지정하려면 no를 추가하여 옵션 이름을 수정합니다. 다음은 예제입니다.
```
$ cdk deploy --watch
$ cdk deploy --no-watch
```
기본값이 true 또는 false인 옵션의 경우 기본값에서 변경하지 않는 한 옵션을 제공할 필요가 없습니다.