CDK - Parameters

 AWS CloudFormation template 은 배포시에 파라미터를 포함시킬 수 있습니다.

AWS CDK Toolkit을 사용하여 CloudFormation template를 배포할 때 명령줄에 파라미터 값을 제공할 수 있습니다.

CloudFormation 콘솔을 통해 template를 배포시에는 파라미터 값을 입력하라는 메시지가 표시됩니다.

일반적으로 CDK 앱이 사용자로 부터 필요한 정보를 받아 구문을 직접 선언하여 사용하는 것이 좋습니다.

이 경우 AWS CloudFormation 템플릿은 구체적이며 배포시 값을 지정하지 않아도 됩니다.

Defining Parameters

CfnParameter 클래스를 사용하여 매개 변수를 정의 하세요.

Description 정보는 AWS CloudFormation 콘솔에서 파라미터 값을 입력하라는 메시지가 표시 될 때 나타납니다.

아래는 typescript 예제입니다.

const uploadBucketName = new CfnParameter(this, "uploadBucketName", {   type: "String",   description: "The name of the Amazon S3 bucket where uploaded files will be stored."});

Using Parameters

파라미터를 사용하려면 사용하려는 클래스 또는 메소드에 필요한 값 유형에 따라 토큰을 검색할 수 있습니다.

아래는 유형에 따라 사용할수 있는 typescript 값입니다.

Property	Kind of value
value	Token class instance
valueAsList	The token represented as a string list
valueAsNumber	The token represented as a number
valueAsString	The token represented as a string

아래는 파라미터를 사용하는 typescript 예제입니다.

const bucket = new Bucket(this, "myBucket",   { bucketName: uploadBucketName.valueAsString});

Deploying with Parameters

 AWS CloudFormation 콘솔을 통해 일반적인 방식으로 배포 할 수 있습니다.

이 경우 각 파라미터의 값을 묻는 프롬프트가 표시됩니다.

 AWS CDK Toolkit은 배포시 파라미터 지정을 할 수 있습니다.

--parameters 를 사용하면 파라미터 값을 지정할 수 있습니다.

아래는 파라미터 사용 예제 입니다.

cdk deploy MyStack --parameters uploadBucketName=UploadBucket

아래는 다중 파라미터 사용 예제입니다.

cdk deploy MyStack --parameters uploadBucketName=UpBucket --parameters downloadBucketName=DownBucket

아래는 다중 스택에서의 파라미터 사용 예제입니다.

cdk deploy MyStack YourStack --parameters MyStack:uploadBucketName=UploadBucket --parameters YourStack:uploadBucketName=UpBucket