AWS SAM CLI - AWS Serverless Application Model
AWS SAMCLI 명령을 문서화하는 방법

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

AWS SAM CLI

AWS Serverless Application Model 명령줄 인터페이스(AWS SAMCLI)는 서버리스 애플리케이션의 로컬 개발 및 테스트를 위한 명령줄 도구입니다. AWS SAMCLI를 사용하면 클라우드에 배포하기 전에 서버리스 애플리케이션을 로컬에서 빌드, 변환, 배포, 디버깅, 패키징, 초기화 및 동기화할 수 있습니다.

AWS SAMCLI는 다양한 수준의 지원과 함께 다양한 프레임워크 및 코드형 인프라(IaC) 도구를 사용하여 정의된 서버리스 애플리케이션에서 작동합니다.

  • AWS SAM 템플릿 - 로컬 테스트, 디버깅, 패키징 및 배포 기능을 포함한 전체 기능 세트를 기본적으로 지원합니다.

  • AWS CDK 애플리케이션 - cdk synth 명령을 사용하여 AWS CDK 애플리케이션을 AWS CloudFormation 템플릿에 합성한 후 Lambda 함수의 로컬 테스트를 지원합니다.

  • AWS CloudFormation 템플릿 -는 표준 AWS CloudFormation 템플릿에 정의된 서버리스 리소스를 AWS SAM AWS CloudFormation지원하므로 직접적인 호환성을 제공합니다.

  • Terraform 애플리케이션 - Lambda 함수의 빌드 및 로컬 테스트에 대한 제한된 지원을 제공합니다. Terraform 정의 Lambda 함수를 나타내는 AWS SAM 템플릿 아티팩트를 생성해야 합니다.

가장 포괄적인 기능 지원과 간소화된 개발자 경험을 위해 기본 AWS SAM 템플릿을 사용하는 것이 좋습니다.

주제

AWS SAMCLI 명령을 문서화하는 방법

AWS SAMCLI 명령은 다음 형식을 사용하여 문서화됩니다.

  • 프롬프트 - Linux 프롬프트는 기본적으로 문서화되며 ($ )로 표시됩니다. Windows와 관련된 명령의 경우 (> )가 프롬프트로 사용됩니다. 명령을 입력할 때 프롬프트를 포함시키지 마세요.

  • 디렉터리 - 특정 디렉터리에서 명령을 실행해야 하는 경우 프롬프트 기호 앞에 디렉터리 이름이 표시됩니다.

  • 사용자 입력 - 명령줄에 입력하는 명령 텍스트는 user input으로 형식이 지정됩니다.

  • 교체 가능한 텍스트 - 파일 이름 및 파라미터와 같은 변수 텍스트는 교체 가능한 텍스트 형식으로 지정됩니다. 특정 키보드 입력이 필요한 여러 줄 명령에서는 키보드 명령도 대체 가능한 텍스트로 표시될 수 있습니다. 예를 들면 ENTER를 입력합니다.

  • 출력 - 명령에 대한 응답으로 반환되는 출력은 computer output와 같은 형식입니다.

다음은 sam deploy 명령의 출력 예입니다.

$ sam deploy --guided --template template.yaml

Configuring SAM deploy
======================

    Looking for config file [samconfig.toml] :  Found
    Reading default arguments  :  Success

    Setting default arguments for 'sam deploy'
    =========================================
    Stack Name [sam-app]: ENTER
    AWS Region [us-west-2]: ENTER
    #Shows you resources changes to be deployed and require a 'Y' to initiate deploy
    Confirm changes before deploy [y/N]: ENTER
    #SAM needs permission to be able to create roles to connect to the resources in your template
    Allow SAM CLI IAM role creation [Y/n]: ENTER
    #Preserves the state of previously provisioned resources when an operation fails
    Disable rollback [y/N]: ENTER
    HelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
    Save arguments to configuration file [Y/n]: ENTER
    SAM configuration file [samconfig.toml]: ENTER
    SAM configuration environment [default]: ENTER

  1. sam deploy --guided --template template.yaml은 명령줄에 입력하는 명령입니다.

  2. sam deploy --guided --template은 있는 그대로 제공되어야 합니다.

  3. template.yaml은 특정 파일 이름으로 바꿀 수 있습니다.

  4. 출력은 Configuring SAM deploy에서 시작됩니다.

  5. 출력에서 ENTER와 y는 사용자가 제공한 대체 가능한 값을 나타냅니다.