[AWS] AWS CloudFormation

 AWS CloudFormation이란 ?

AWS에서 인프라를 코드로(Infrastructure as Code, IaC) 관리할 수 있는 서비스이다.
CloudFormation을 사용하면 인프라 리소스를 텍스트 파일(템플릿)로 정의하고, 이를 통해 AWS 리소스(예: EC2 인스턴스, S3 버킷, RDS 데이터베이스 등)를 자동으로 생성, 관리, 업데이트할 수 있다.

CloudFormation 템플릿을 재사용하여 리소스를 일관되고 반복적으로 생성 가능하다. 

즉, 인프라를 구성하는 시간과 과정을 단축시켜준다 !

 

✳️ EC2 인스턴스 생성 템플릿 예시 

AWSTemplateFormatVersion: "2010-09-09"
Description: "AWS CloudFormation Template to create an EC2 instance"
Resources:
  MyEC2Instance:
    Type: "AWS::EC2::Instance"
    Properties:
      InstanceType: "t2.micro"
      ImageId: "ami-0abcdef1234567890"

---

✳️ 작동 방식 

• 템플릿을 생성해 AWS 리소스와 해당 속성에 대해 설명하고 스택을 생성한다.
• 스택을 생성할 때마다 CloudFormation에서 템플릿에 설명된 리소스를 프로비저닝한다.

 

 

템플릿

JSON 또는 YAML 형식의 텍스트 파일로 AWS 리소스 구축을 위한 청사진

👉템플릿에서 인스턴스 유형, AMI ID, 블록 디바이스 매핑, Amazon EC2 키 페어 이름 등과 같은 Amazon EC2 인스턴스를 설명

• 템플릿이 저장되는 위치는 Amazon S3 버킷 또는 Git 리포지토리

 

 

템플릿 섹션

모든 CloudFormation 템플릿은 하나 이상의 섹션으로 구성되며, 각 섹션에는 특정한 목적이 있다

✳️ 템플릿 섹션 

---
AWSTemplateFormatVersion: version date

Description:
  String

Metadata:
  template metadata

Parameters:
  set of parameters

Rules:
  set of rules

Mappings:
  set of mappings

Conditions:
  set of conditions

Transform:
  set of transforms

Resources:
  set of resources

Outputs:
  set of outputs

 

---

• Resources 
  • CloudFormation 템플릿에 필요하고 템플릿의 핵심을 구성
  • Amazon EC2 인스턴스 또는 Amazon S3 버킷 같은 스택 리소스 및 해당 속성을 지정
  • 각 리소스는 고유한 논리적 ID, 유형 및 특정 구성 세부 정보로 정의

Resources:
  LogicalResourceName1:
    Type: AWS::ProductIdentifier::ResourceType
    Properties:
      PropertyName1: PropertyValue1
      ...

  LogicalResourceName2:
    Type: AWS::ProductIdentifier::ResourceType
    Properties:
      PropertyName1: PropertyValue1
      ...

 

• 각 리소스에는 Type 속성이 있어야 하며, 이 속성은 AWS 리소스의 종류를 정의 
  👉Amazon S3 버킷의 Type 속성은 AWS::S3::Bucket
  🔗 리소스 및 속성 참조

 

• 참조 리소스로 동일한 CloudFormation 템플릿 내에 정의된 리소스의 식별 속성을 검색
  👉 Ref 함수 사용 

Properties:
  PropertyName1:
    Ref: LogicalResourceName
  PropertyName2: !Ref LogicalResourceName

---

• Parameters
  • 선택 사항이지만 템플릿을 보다 유연하게 만드는 데 중요한 역할
  • 배포마다 달라지는 인스턴스 유형이나 환경 설정을 지정

Parameters:
  ParameterLogicalID:
    Description: Information about the parameter
    Type: DataType
    Default: value
    AllowedValues:
      - value1
      - value2

---

• Outputs 
  • 스택의 속성을 볼 때 반환되는 값을 정의
  • 리소스 식별자 또는 URL과 같은 유용한 정보를 제공

Outputs:
  Logical ID of resource:
    Description: Information about the value
    Value: Value to return
    Export:
      Name: Name of resource to export

 

 

 

템플릿 내장함수 

팀 내에서 사용하고 있는 내장함수 위주로 정리

 

• Fn::ImportValue
  • 다른 스택에서 내보낸 출력값 반환
  • Fn::ImportValue: sharedValueToImport 👉 함수 전체 
    !ImportValue sharedValueToImport 👉 짧은 형식

Fn::ImportValue:
  !Sub "${NetworkStackName}-SecurityGroupID"

⛔ !Sub의 짧은 형식이 포함되면 !ImportValue의 짧은 형식 사용 불가 !

---

• Fn::Join
  • 지정된 구분 기호로 구분된 값 세트를 단일 값에 추가
  • 구분 기호가 빈 문자열이면 값 세트는 구분 기호 없이 연결됨
  • Fn::Join: [ delimiter, [ comma-delimited list of values ] ] 👉 함수 전체 
    !Join [ delimiter, [ comma-delimited list of values ] ] 👉 짧은 형식
  • delimiter : 조각 두 개 사이에서 발생하길 원하는 값
  • ListOfValues : 결합하려는 값 목록

!Join [ '', [ 'arn:aws:codepipeline:', !Ref 'AWS::Region', ':', !Ref 'AWS::AccountId', ':', !Ref CodePipelineProject ] ]

!Join
  - ''
  - - 'arn:'
    - !Ref AWS::Partition
    - ':s3:::elasticbeanstalk-*-'
    - !Ref AWS::AccountId

👉 Ref 함수와 사용해서 연결한 예시
👉 arn:aws:s3:::elasticbeanstalk-us-east-1-123456789012

- 첫번째 인자는 구분자로, 예시에서는 빈문자열('')이므로 결합된 문자열 사이에 추가적인 문자가 들어가지 않음
- !Ref는 CloudFormation에서 특정 값을 참조하는 함수
- 'elasticbeanstalk-*-' 은 와일드카드(*)를 사용하여 리전명을 동적으로 처리

---

• Fn::Sub
  • 입력 문자열의 변수를 지정한 값으로 바꿈

Fn::Sub:
  - String
  - Var1Name: Var1Value
    Var2Name: Var2Value

!Sub
  - String
  - Var1Name: Var1Value
    Var2Name: Var2Value

InstanceSecurityGroup:
  Type: AWS::EC2::SecurityGroup
  Properties:
    GroupDescription: !Sub "SSH security group for ${AWS::StackName}"

---

• Ref
  • 지정된 파라미터 또는 리소스에 대한 정보를 반환
  • Ref: logicalName 👉 함수 전체
    !Ref logicalName 👉 짧은 형식

MyEIP:
  Type: "AWS::EC2::EIP"
  Properties:
    InstanceId: !Ref MyEC2Instance

 

 

 

 

참고자료

https://docs.aws.amazon.com/ko_kr/AWSCloudFormation/latest/UserGuide/Welcome.html