'AWS CDK 부트스트랩' 작업 YAML - Amazon CodeCatalyst

'AWS CDK 부트스트랩' 작업 YAML

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

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

참고

이어지는 대부분의 YAML 속성에는 시각적 편집기에 해당 UI 요소가 있습니다. UI 요소를 찾으려면 Ctrl+F를 사용합니다. 요소가 연결된 YAML 속성과 함께 나열됩니다.

# The workflow definition starts here. # See 최상위 속성 for details. Name: MyWorkflow SchemaVersion: 1.0 Actions: # The action definition starts here. CDKBootstrapAction_nn: Identifier: aws/cdk-bootstrap@v2 DependsOn: - action-name 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_bootstrap_artifacts Files: - "cdk.out/**/*" Environment: Name: environment-name Connections: - Name: account-connection-name Role: iam-role-name Configuration: Region: us-west-2 CdkCliVersion: version

CDKBootstrapAction

(필수)

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

기본값: CDKBootstrapAction_nn.

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

Identifier

(CDKBootstrapAction/Identifier)

(필수)

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

참고

aws/cdk-bootstrap@v2을 지정하면 Node.js 18과 같은 최신 도구가 포함된 2024년 3월 이미지에서 작업이 실행됩니다. aws/cdk-bootstrap@v1을 지정하면 Node.js 16과 같은 이전 도구가 포함된 2022년 11월 이미지에서 작업이 실행됩니다.

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

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

DependsOn

(CDKBootstrapAction/DependsOn)

(선택 사항)

이 작업을 실행하기 위해 성공적으로 실행해야 하는 작업, 작업 그룹 또는 게이트를 지정합니다.

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

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

Compute

(CDKBootstrapAction/Compute)

(선택 사항)

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

해당 UI: 없음

Type

(CDKBootstrapAction/Compute/Type)

(Compute 포함 시 필수)

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

  • EC2(시각 편집기) 또는 EC2(YAML 편집기)

    작업 실행 중 유연성을 위해 최적화되었습니다.

  • Lambda(시각 편집기) 또는 Lambda(YAML 편집기)

    작업 시작 속도를 최적화했습니다.

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

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

Fleet

(CDKBootstrapAction/Compute/Fleet)

(선택 사항)

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

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

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

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

Timeout

(CDKBootstrapAction/Timeout)

(필수)

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

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

Inputs

(CDKBootstrapAction/Inputs)

(선택 사항)

Inputs 섹션에서는 워크플로 실행 중에 AWS CDK 부트스트랩 작업에 필요한 데이터를 정의합니다.

해당 UI: 입력

참고

AWS CDK 부트스트랩 작업에 대해 하나의 입력(소스 또는 아티팩트)만 허용됩니다.

Sources

(CDKBootstrapAction/Inputs/Sources)

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

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

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

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

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

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

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

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

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

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

Outputs

(CDKBootstrapAction/Outputs)

(선택 사항)

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

해당 UI: 출력

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(선택 사항)

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

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

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

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Artifacts - output 포함 시 필수)

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

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

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Artifacts - output 포함 시 필수)

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

참고

cdk.out 는 합성된 파일이 저장되는 기본 디렉터리입니다. cdk.json 파일에 이외의 출력 디렉터리를 지정한 경우 대신 여기에 해당 디렉터리cdk.out를 지정합니다cdk.out.

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

Environment

(CDKBootstrapAction/Environment)

(필수)

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

참고

기본 IAM 역할에 작업에 필요한 권한이 없는 경우 다른 역할을 사용하도록 작업을 구성할 수 있습니다. 자세한 내용은 작업의 IAM 역할 변경 섹션을 참조하세요.

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

해당 UI: 구성 탭/환경

Name

(CDKBootstrapAction/Environment/Name)

(Environment 포함 시 필수)

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

해당 UI: 구성 탭/환경

Connections

(CDKBootstrapAction/Environment/Connections)

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

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

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

  • 이 작업은 CodeCatalyst 콘솔의 환경에 지정된 AWS 계정 연결 및 기본 IAM 역할을 사용합니다. 환경에 계정 연결 및 기본 IAM 역할을 추가하는 방법에 대한 자세한 내용은 환경 생성 섹션을 참조하세요.

  • 기본 IAM 역할에는 작업에 필요한 정책 및 권한이 포함되어야 합니다. 이러한 정책 및 권한이 무엇인지 확인하려면 작업의 YAML 정의 설명서에서 역할 속성에 대한 설명을 참조하세요.

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

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

  • (최신 버전) 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

  • (이전 버전) 구성 탭/'환경/계정/역할'/AWS 계정 연결

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Connections 포함 시 필수)

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

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

  • (최신 버전) 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

  • (이전 버전) 구성 탭/'환경/계정/역할'/AWS 계정 연결

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Connections 포함 시 필수)

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

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

참고

다음 권한 정책에 표시된 권한은 쓰기 시점에 부트스트래핑을 수행하기 위해 cdk bootstrap 명령에 필요한 권한입니다. 가 부트스트랩 명령을 AWS CDK 변경하면 이러한 권한이 변경될 수 있습니다.

주의

AWS CDK 부트스트랩 작업에서만 이 역할을 사용합니다. 매우 허용적이며 다른 작업과 함께 사용하면 보안 위험이 발생할 수 있습니다.

  • 다음 권한 정책:

    { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "iam:GetRole", "ssm:GetParameterHistory", "ecr:PutImageScanningConfiguration", "cloudformation:*", "iam:CreateRole", "iam:AttachRolePolicy", "ssm:GetParameters", "iam:PutRolePolicy", "ssm:GetParameter", "ssm:DeleteParameters", "ecr:DeleteRepository", "ssm:PutParameter", "ssm:DeleteParameter", "iam:PassRole", "ecr:SetRepositoryPolicy", "ssm:GetParametersByPath", "ecr:DescribeRepositories", "ecr:GetLifecyclePolicy" ], "Resource": [ "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*", "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*", "arn:aws:ecr:aws-region:aws-account:repository/cdk-*", "arn:aws:iam::aws-account:role/cdk-*" ] }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": [ "cloudformation:RegisterType", "cloudformation:CreateUploadBucket", "cloudformation:ListExports", "cloudformation:DescribeStackDriftDetectionStatus", "cloudformation:SetTypeDefaultVersion", "cloudformation:RegisterPublisher", "cloudformation:ActivateType", "cloudformation:ListTypes", "cloudformation:DeactivateType", "cloudformation:SetTypeConfiguration", "cloudformation:DeregisterType", "cloudformation:ListTypeRegistrations", "cloudformation:EstimateTemplateCost", "cloudformation:DescribeAccountLimits", "cloudformation:BatchDescribeTypeConfigurations", "cloudformation:CreateStackSet", "cloudformation:ListStacks", "cloudformation:DescribeType", "cloudformation:ListImports", "s3:*", "cloudformation:PublishType", "ecr:CreateRepository", "cloudformation:DescribePublisher", "cloudformation:DescribeTypeRegistration", "cloudformation:TestType", "cloudformation:ValidateTemplate", "cloudformation:ListTypeVersions" ], "Resource": "*" } ] }
    참고

    역할을 처음 사용할 때는 리소스 정책 설명에서 다음 와일드카드를 사용한 다음 사용 가능한 리소스 이름으로 정책의 범위를 좁힙니다.

    "Resource": "*"
  • 다음 사용자 지정 신뢰 정책:

    { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codecatalyst-runner.amazonaws.com", "codecatalyst.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }
참고

원하는 경우 이 작업에서 CodeCatalystWorkflowDevelopmentRole-spaceName 역할을 사용할 수 있습니다. 이에 대한 자세한 내용은 계정 및 스페이스의 CodeCatalystWorkflowDevelopmentRole-spaceName 역할 생성 섹션을 참조하세요. CodeCatalystWorkflowDevelopmentRole-spaceName 역할에 보안 위험을 초래할 수 있는 전체 액세스 권한이 있음을 이해합니다. 보안에 대한 우려가 적은 자습서 및 시나리오에서만 이 역할을 사용하는 것이 좋습니다.

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

  • (최신 버전) 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

  • (이전 버전) 구성 탭/'환경/계정/역할'/역할

Configuration

(CDKBootstrapAction/Configuration)

(필수)

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

해당 UI: 구성

Region

(CDKBootstrapAction/Configuration/Region)

(필수)

부트스트랩 스택을 배포할 AWS 리전 를 지정합니다. 이 리전은 AWS CDK 앱이 배포된 리전과 일치해야 합니다. 리전 코드 목록은 리전 엔드포인트를 참조하세요.

해당 UI: 구성 탭/리전

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(선택 사항)

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

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

  • 이 작업을 사용할 AWS Cloud Development Kit (AWS CDK) 명령줄 인터페이스(CLI)의 전체 버전(AWS CDK 툴키트라고도 함). 예시: 2.102.1. 애플리케이션을 구축하고 배포할 때 일관성과 안정성을 보장하기 위해 전체 버전을 지정하는 것이 좋습니다.

    Or

  • latest. CDK CLI의 최신 기능과 수정 사항을 활용하도록 latest를 지정하는 것이 좋습니다.

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

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

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

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