'AWS CDK 배포' 작업 YAML

다음은 AWS CDK 배포 작업의 YAML 정의입니다. 이러한 작업 사용 방법을 배우려면 워크플로를 사용하여 AWS CDK 앱 배포 섹션을 참조하세요.

이 작업 정의는 더 광범위한 워크플로 정의 파일 내의 섹션으로 존재합니다. 이 파일에 대한 자세한 내용은 워크플로 YAML 정의을 참조합니다.

# The workflow definition starts here.
# See 최상위 속성 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  CDKDeploy_nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
    Outputs:
      Artifacts:
        - Name: cdk_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out

CDKDeploy

(필수)

작업 이름을 지정합니다. 워크플로 내의 모든 작업 이름은 고유해야 합니다. 작업 이름은 영숫자 문자(a-z, A-Z, 0-9), 하이픈(-) 및 밑줄(_)로 제한됩니다. 스페이스은 허용되지 않습니다. 작업 이름에서 특수 문자와 공백을 활성화하는 데 따옴표를 사용할 수 없습니다.

기본값: CDKDeploy_nn.

해당 UI: 구성 탭/작업 이름

Identifier

(CDKDeploy/Identifier)

(필수)

작업을 식별합니다. 버전을 변경하려는 경우가 아니면 이 속성을 변경하지 마세요. 자세한 내용은 사용할 작업 버전 지정 섹션을 참조하십시오.

기본값: aws/cdk-deploy@v2.

해당 UI: 워크플로 다이어그램/CDKDeploy_nn/aws/cdk-deploy@v2 레이블

DependsOn

(CDKDeploy/DependsOn)

(선택 사항)

AWS CDK 배포 작업을 실행하려면 성공적으로 실행해야 하는 작업 또는 작업 그룹을 지정합니다. 다음과 같이 DependsOn 속성에서 AWS CDK 부트스트랩 작업을 지정하는 것이 좋습니다.

CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap

'depends on' 함수에 대한 자세한 내용은 작업 순서 지정 섹션을 참조하세요.

해당 UI: 입력 탭/의존 - 선택 사항

Compute

(CDKDeploy/Compute)

(선택 사항)

워크플로 작업을 실행하는 데 사용되는 컴퓨팅 엔진입니다. 워크플로 수준 또는 작업 수준에서 컴퓨팅을 지정할 수 있지만 둘 다 지정할 수는 없습니다. 워크플로 수준에서 지정하면 컴퓨팅 구성이 워크플로에 정의된 모든 작업에 적용됩니다. 워크플로 수준에서는 동일한 인스턴스에서 여러 작업을 실행할 수도 있습니다. 자세한 내용은 작업 간에 컴퓨팅 공유 섹션을 참조하십시오.

해당 UI: 없음

Type

(CDKDeploy/Compute/Type)

(Compute 포함 시 필수)

컴퓨팅 엔진의 유형입니다. 다음 값 중 하나를 사용할 수 있습니다.

컴퓨팅 유형에 대한 자세한 정보는 컴퓨팅 유형을 참고하세요.

해당 UI: 구성 탭/고급 - 선택 사항/컴퓨팅 유형

Fleet

(CDKDeploy/Compute/Fleet)

(선택 사항)

워크플로 또는 워크플로 작업을 실행할 시스템 또는 플릿을 지정합니다. 온디맨드 플릿의 경우 작업이 시작되면 워크플로가 필요한 리소스를 프로비저닝하고 작업이 완료되면 시스템이 파괴됩니다. 온디맨드 플릿의 예시: Linux.x86-64.Large, Linux.x86-64.XLarge. 온디맨드 플릿에 대한 자세한 내용은 온디맨드 플릿 속성 섹션을 참조하세요.

프로비저닝된 플릿을 사용하면 워크플로 작업을 실행하도록 전용 시스템 세트를 구성할 수 있습니다. 이러한 시스템은 유휴 상태로 유지되므로 작업을 즉시 처리할 수 있습니다. 프로비저닝된 플릿에 대한 자세한 내용은 프로비저닝된 플릿 속성 섹션을 참조하세요.

Fleet 생략 시 기본값은 Linux.x86-64.Large입니다.

해당 UI: 구성 탭/고급 - 선택적/컴퓨팅 플릿

Timeout

(CDKDeploy/Timeout)

(필수)

CodeCatalyst가 작업을 종료하기 전에 작업을 실행할 수 있는 시간을 분(YAML 편집기) 또는 시간 및 분(시각적 편집기) 단위로 지정합니다. 최소값은 5분이고 최대값은 CodeCatalyst의 워크플로 할당량에 설명되어 있습니다. 기본 제한 시간은 최대 제한 시간과 동일합니다.

해당 UI: 구성 탭/제한 시간 - 선택 사항

Inputs

(CDKDeploy/Inputs)

(선택 사항)

이 Inputs 섹션에서는 워크플로 실행 중에 에 CDKDeploy 필요한 데이터를 정의합니다.

해당 UI: 입력 탭

Sources

(CDKDeploy/Inputs/Sources)

(배포하려는 AWS CDK 앱이 소스 리포지토리에 저장된 경우 필수)

AWS CDK 앱이 소스 리포지토리에 저장된 경우 해당 소스 리포지토리의 레이블을 지정합니다. AWS CDK 배포 작업은 배포 프로세스를 시작하기 전에 이 리포지토리의 앱을 합성합니다. 현재, WorkflowSource 레이블만 지원됩니다.

AWS CDK 앱이 소스 리포지토리에 포함되어 있지 않은 경우 다른 작업에서 생성된 아티팩트에 있어야 합니다.

소스에 대한 자세한 내용은 워크플로에 소스 리포지토리 연결 섹션을 참조하십시오.

해당 UI: 입력 탭/소스 - 선택 사항

Artifacts - input

(CDKDeploy/Inputs/Artifacts)

(배포하려는 AWS CDK 앱이 이전 작업의 출력 아티팩트에 저장된 경우 필수)

AWS CDK 앱이 이전 작업에서 생성된 아티팩트에 포함된 경우 여기에 해당 아티팩트를 지정합니다. AWS CDK 배포 작업은 배포 프로세스를 시작하기 전에 지정된 아티팩트의 앱을 CloudFormation 템플릿으로 합성합니다. AWS CDK 앱이 아티팩트 내에 포함되어 있지 않은 경우 앱은 소스 리포지토리에 있어야 합니다.

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

해당 UI: 입력 탭/아티팩트 - 선택 사항

Outputs

(CDKDeploy/Outputs)

(선택 사항)

워크플로 실행 중에 작업에 의해 출력되는 데이터를 정의합니다.

해당 UI: 출력 탭

Artifacts - output

(CDKDeploy/Outputs/Artifacts

(선택 사항)

작업에서 생성된 아티팩트를 지정합니다. 이러한 아티팩트를 다른 작업의 입력으로 참조할 수 있습니다.

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

해당 UI: 출력 탭/아티팩트

Name

(CDKDeploy/Outputs/Artifacts/Name)

(Artifacts - output 포함 시 필수)

런타임에 AWS CDK 배포 작업으로 합성되는 AWS CloudFormation 템플릿을 포함할 아티팩트의 이름을 지정합니다. 기본값은 cdk_artifact입니다. 아티팩트를 지정하지 않으면 작업이 템플릿을 합성하지만 아티팩트에 저장하지는 않습니다. 테스트 또는 문제 해결을 위해 합성된 템플릿을 아티팩트에 저장하여 레코드를 보존하는 것이 좋습니다.

해당 UI: 출력 탭/아티팩트/아티팩트 추가/빌드 아티팩트 이름

Files

(CDKDeploy/Outputs/Artifacts/Files)

(Artifacts - output 포함 시 필수)

아티팩트에 포함할 파일을 지정합니다. AWS CDK 앱의 합성된 AWS CloudFormation 템플릿을 "cdk.out/**/*" 포함하도록 를 지정해야 합니다.

해당 UI: 출력 탭/아티팩트/아티팩트 추가/빌드에서 생성된 파일

Environment

(CDKDeploy/Environment)

(필수)

작업에 사용할 CodeCatalyst 환경을 지정합니다. 작업은 선택한 환경에 지정된 AWS 계정 및 선택적 Amazon VPC에 연결됩니다. 작업은 환경에 지정된 기본 IAM 역할을 사용하여 AWS 계정에 연결하고 Amazon VPC 연결에 지정된 IAM 역할을 사용하여 Amazon VPC에 연결합니다.

환경에 대한 자세한 내용은 AWS 계정 및 VPC에 배포 및 환경 생성 섹션을 참조하세요.

해당 UI: 구성 탭/환경

Name

(CDKDeploy/Environment/Name)

(Environment 포함 시 필수)

작업과 연결하려는 기존 환경의 이름을 지정합니다.

해당 UI: 구성 탭/환경

Connections

(CDKDeploy/Environment/Connections)

(최신 버전의 작업에서는 선택 사항, 이전 버전에서는 필수)

작업과 연결할 계정 연결을 지정합니다. Environment에서 계정 연결을 최대 1개까지 지정할 수 있습니다.

계정 연결을 지정하지 않는 경우:

계정 연결에 대한 자세한 정보는 연결된 AWS 계정로 AWS 리소스에 대한 액세스 허용 섹션을 참조하세요. 환경에 계정 연결을 추가하는 방법에 대한 자세한 내용은 환경 생성 섹션을 참조하세요.

해당 UI: 작업 버전에 따라 다음 중 하나:

Name

(CDKDeploy/Environment/Connections/Name)

(Connections 포함 시 필수)

계정 연결의 이름을 지정합니다.

해당 UI: 작업 버전에 따라 다음 중 하나:

Role

(CDKDeploy/Environment/Connections/Role)

(Connections 포함 시 필수)

계정 연결의 이름을 지정합니다.

AWS CDK 배포 작업이 AWS CDK 애플리케이션 스택에 액세스AWS하고 배포하는 데 사용하는 IAM 역할의 이름을 지정합니다. CodeCatalyst 스페이스에 역할을 추가했고 역할에 다음 정책이 포함되어 있는지 확인합니다.

IAM 역할을 지정하지 않으면 작업은 CodeCatalyst 콘솔의 환경에 나열된 기본 IAM 역할을 사용합니다. 환경에서 기본 역할을 사용하는 경우 다음 정책이 있는지 확인합니다.

해당 UI: 작업 버전에 따라 다음 중 하나:

Configuration

(CDKDeploy/Configuration)

(필수)

작업의 구성 속성을 정의할 수 있는 섹션입니다.

해당 UI: 구성 탭

StackName

(CDKDeploy/Configuration/StackName)

(필수)

AWS CDK 앱의 bin 디렉터리 진입점 파일에 표시되는 AWS CDK 앱 스택의 이름입니다. 다음 예시에서는 스택 이름이 빨간색 기울임꼴로 강조 표시된 TypeScript 진입점 파일의 내용을 보여줍니다. 진입점 파일이 다른 언어로 되어 있는 경우 비슷해 보일 것입니다.

import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

const app = new cdk.App();
new CdkWorkshopTypescriptStack(app, 'CdkWorkshopTypescriptStack');

하나의 스택만 지정할 수 있습니다.

해당 UI: 구성 탭/스택 이름

Region

(CDKDeploy/Configuration/Region)

(선택 사항)

AWS CDK 애플리케이션 스택을 배포할 AWS 리전 를 지정합니다. 리전 코드 목록은 리전 엔드포인트를 참조하세요.

리전을 지정하지 않으면 AWS CDK 배포 작업이 AWS CDK 코드에 지정된 리전에 배포됩니다. 자세한 내용을 알아보려면 AWS Cloud Development Kit (AWS CDK) 개발자 안내서의 환경을 참조하세요.

해당 UI: 구성 탭/리전

Tags

(CDKDeploy/Configuration/Tags)

(선택 사항)

AWS CDK 애플리케이션 스택의 AWS 리소스에 적용할 태그를 지정합니다. 태그는 스택 자체뿐만 아니라 스택의 개별 리소스에도 적용됩니다. 태그에 대한 자세한 내용을 알아보려면 AWS Cloud Development Kit (AWS CDK) 개발자 안내서의 태그 지정을 참조하세요.

해당 UI: 구성 탭/고급 - 선택적/태그

Context

(CDKDeploy/Configuration/Context)

(선택 사항)

AWS CDK 애플리케이션 스택과 연결할 컨텍스트를 키-값 페어 형식으로 지정합니다. 컨텍스트에 대한 자세한 내용을 알아보려면 AWS Cloud Development Kit (AWS CDK)개발자 안내서의 런타임 컨텍스트를 참조하세요.

해당 UI: 구성 탭/고급 - 선택 사항/컨텍스트

CdkCliVersion

(CDKDeploy/Configuration/CdkCliVersion)

(선택 사항)

이 속성은 버전 1.0.13 이상의 AWS CDK 배포 작업과 버전 1.0.8 이상의 AWS CDK 부트스트랩 작업에서 사용할 수 있습니다.

다음 중 하나를 지정하세요.

이 작업은 지정된 AWS CDK CLI 버전(또는 최신 버전)을 CodeCatalyst 빌드 이미지에 다운로드한 다음 이 버전을 사용하여 CDK 애플리케이션을 배포하거나 AWS 환경을 부트스트랩하는 데 필요한 명령을 실행합니다.

사용할 수 있는 지원되는 CDK CLI 버전 목록은 AWS CDK 버전 섹션을 참조하세요.

이 속성을 생략하면 다음 주제 중 하나에 설명된 기본 AWS CDK CLI 버전을 사용합니다.

해당 UI: 구성 탭/AWS CDK CLI 버전

CdkRootPath

(CDKDeploy/Configuration/CdkRootPath)

(선택 사항)

AWS CDK 프로젝트의 cdk.json 파일이 포함된 디렉터리의 경로입니다. AWS CDK 배포 작업은 이 폴더에서 실행되며 작업에서 생성된 모든 출력이 이 디렉터리에 추가됩니다. 지정되지 않은 경우 AWS CDK 배포 작업은 cdk.json 파일이 AWS CDK 프로젝트의 루트에 있다고 가정합니다.

해당 UI: cdk.json이 있는 구성 탭/디렉터리

CfnOutputVariables

(CDKDeploy/Configuration/CfnOutputVariables)

(선택 사항)

워크플로 출력 변수로 노출하려는 AWS CDK 애플리케이션 코드의 CfnOutput 구문을 지정합니다. 그런 다음 워크플로의 후속 작업에서 워크플로 출력 변수를 참조할 수 있습니다. CodeCatalyst의 변수에 대한 자세한 내용은 워크플로에서 변수 사용 섹션을 참조하세요.

예를 들어 AWS CDK 애플리케이션 코드가 다음과 같은 경우:

import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}

...그리고 CfnOutputVariables 속성은 다음과 같습니다.

Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'

...그런 다음 작업은 다음과 같은 워크플로 출력 변수를 생성합니다.

그런 다음 후속 작업에서 bucketName 및 tableName 변수를 참조할 수 있습니다. 후속 작업에서 워크플로 출력 변수를 참조하는 방법을 알아보려면 사전 정의된 변수 참조 섹션을 참조하세요.

CfnOutputVariables 속성에서 CfnOutput 구문을 지정하지 않으면 작업에서 워크플로 출력 변수로 찾는 처음 4개(또는 그 이하)의 CloudFormation 출력 변수가 표시됩니다. 자세한 내용은 'AWS CDK 배포' 변수 섹션을 참조하십시오.

AWS CloudFormation 출력 변수에 대한 자세한 내용은 AWS Cloud Development Kit (AWS CDK) API 참조의 클래스 CfnOutput(구문)에서 제공되는 CfnOutput 구문에 대한 설명서를 참조하세요.

해당 UI: 구성 탭/AWS CloudFormation 출력 변수

CloudAssemblyRootPath

(CDKDeploy/Configuration/CloudAssemblyRootPath)

(선택 사항)

AWS CDK 앱 스택을 클라우드 어셈블리로 이미 합성한 경우(cdk synth 작업 사용) 클라우드 어셈블리 디렉터리의 루트 경로를 지정합니다(cdk.out). 지정된 클라우드 어셈블리 디렉터리에 있는 AWS CloudFormation 템플릿은 cdk deploy --app 명령을 사용하여 AWS 계정에 AWS CDK 배포 작업을 통해 배포됩니다. --app 옵션이 있으면 cdk synth 작업이 발생하지 않습니다.

클라우드 어셈블리 디렉터리를 지정하지 않으면 AWS CDK 배포 작업이 --app 옵션 없이 cdk deploy 명령을 실행합니다. --app 옵션이 없으면 cdk deploy 작업은 합성하고(cdk synth) AWS CDK 앱을 AWS 계정에 배포합니다.

“AWS CDK 배포” 작업이 런타임에 합성을 수행할 수 있는 경우 기존 합성 클라우드 어셈블리를 지정하는 이유는 무엇입니까?

기존 합성 클라우드 어셈블리를 지정하여 다음을 수행할 수 있습니다.

AWS CDK 앱을 설치하고 실행하기 위한 명령을 포함하도록 cdk.json 파일을 구성하는 방법에 대한 자세한 내용은 앱 명령 지정을 참조하세요.

cdk deploy 및 cdk synth 명령과 --app 옵션에 대한 자세한 내용은 AWS Cloud Development Kit (AWS CDK) 개발자 안내서의 스택 배포, 스택 합성 및 합성 건너뛰기를 참조하세요.

클라우드 어셈블리에 대한 자세한 내용은 AWS Cloud Development Kit (AWS CDK) API 참조의 클라우드 어셈블리를 참조하세요.

해당 UI: 구성 탭/클라우드 어셈블리 디렉터리 경로