【初心者向け】 AWS CloudFormationの組み込み関数を使って 柔軟なCFnテンプレートを作成しよう 2022/7/28 AWS事業本部 たぬき

自己紹介 たぬき 所属 ❏ AWS事業本部 コンサルティング部 ❏ 東京オフィス 最近勉強したAWSサービス ❏ Amazon Rekognition Twitter ❏ たぬき (@tanuki_tzp) DevelopersIO Blog

CloudFormation使ってますか？

本セッションでお話すること ● CloudFormationで使う組み込み関数について

● AWS CloudFormationの詳しい解説 ● テンプレートの基本的な書き方について 本セッションでお話しないこと

CloudFormationについて

● AWSのインフラストラクチャをコードで管理するための サービス ● リソースの作成、変更、削除を自動化 CloudFormationとは

CloudFormationがリソースを作るための発注書 CFn のテンプレートとは

CFn のテンプレートとは

組み込み関数について

組み込み関数とは ● CloudFormationにはビルドインの組み込み関数が用意 されている ● 組み込み関数を使用してテンプレート内でデータの変換 や操作を行うことができる

AWS公式ドキュメント 組み込み関数リファレンス - AWS CloudFormation https://docs.aws.amazon.com/ja_jp/AWSCloudFormatio n/latest/UserGuide/intrinsic-function-reference.html 組み込み関数の種類

組み込み関数の種類 (2023/7/1 時点)

多い

今回の対象関数 (2023/7/1 時点)

今回のやってみる シンプルなCFnテンプレートに 関数を使用してみよう

ベースの構成図

テンプレートはyaml形式となります ※ブログにテンプレートを掲載しております ベースのCFnテンプレート AWSTemplateFormatVersion: "2010-09-09" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24

ベースのCFnテンプレート AWSTemplateFormatVersion: "2010-09-09" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24

Ref

● 指定された論理名に対応するリソースやパラメーターの 値を返す 例：VpcId: !Ref VPC → “VPC”というVPCのVPCID 組み込み関数 - Ref AWSTemplateFormatVersion: "2010-09-09" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24 AWSTemplateFormatVersion: "2010-09-09" Resources: SampleVPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref SampleVPC CidrBlock: 10.0.0.0/24

戻り値については公式のリファレンスのReturn valuesを参 照 AWS リソースおよびプロパティタイプのリファレンス https://docs.aws.amazon.com/ja_jp/AWSCloudFormatio n/latest/UserGuide/aws-template-resource-type-ref.html 組み込み関数 - Ref

組み込み関数 - Ref 例：VPCのReturn values Amazon EC2 resource type reference - AWS CloudFormation https://docs.aws.amazon.com/ja_jp/AWSCloudFormatio n/latest/UserGuide/AWS_EC2.html

Select

組み込み関数 - Select ● 要素のリストを条件に応じて選択する

組み込み関数 - Select 例：リストからパラメータで指定して、EC2インスタンスを起動 するアベイラビリティゾーンを選択 Parameters: AvailabilityZones: Type: List Default: - ap-northeast-1a - ap-northeast-1c - ap-northeast-1d Resources: EC2Instance: Type: AWS::EC2::Instance Properties: AvailabilityZone: !Select [0, !Ref AvailabilityZones]

組み込み関数 - Select リストにない要素は選択できない Nullに対応できない

Cidr

組み込み関数 - Cidr テンプレートを使い回すために可変であってほしい箇所 AWSTemplateFormatVersion: "2010-09-09" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24

組み込み関数 - Cidr ● 指定されたCIDRブロック範囲内のIPアドレスを生成

組み込み関数 - Cidr CidrとSelectを組み合わせてテンプレートに組み込み AWSTemplateFormatVersion: "2010-09-09" Parameters: VpcCidrBlock: Type: String Default: "10.0.0.0/16" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: !Ref VpcCidrBlock Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8]

組み込み関数 - Cidr !Cidr !Ref VpcCidrBlock, 1, 8 VpcCidrBlock = 分割前のCidrブロック (10.0.0.0/16) 1 = 生成するサブネットのCidrブロックの数 8 = 生成するサブネットビット数 !Cidr !Ref VpcCidrBlock, 1, 8 = 10.0.0.0/24

組み込み関数 - Cidr サブネットビット数について

組み込み関数 - Cidr !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8] 0 = 1番目の要素 !Cidr !Ref VpcCidrBlock, 1, 8 = 10.0.0.0/24 !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8] = 10.0.0.0/24

組み込み関数 - Cidr !Cidr !Ref VpcCidrBlock, 2, 8 VpcCidrBlock = 分割前のCidrブロック (10.0.0.0/16) 2 = 生成するサブネットのCidrブロックの数 8 = 生成するサブネットビット数 !Cidr !Ref VpcCidrBlock, 2, 8 = 10.0.0.0/24, 10.0.1.0/24

組み込み関数 - Cidr !Select [1, !Cidr !Ref VpcCidrBlock, 2, 8] 1 = 2番目の要素 !Cidr !Ref VpcCidrBlock, 2, 8 = 10.0.0.0/24, 10.0.1.0/24 !Select [1, !Cidr !Ref VpcCidrBlock, 2, 8] = 10.0.1.0/24

Join

組み込み関数 - Join ● 文字列やリストの要素を指定した区切り文字で結合する

組み込み関数 - Join !Join [区切り文字, [要素1, 要素2, ...]] !Join [“-”, [“xxx”, “yyy”, “zzz”]] → xxx-yyy-zzz

組み込み関数 - Join AWSTemplateFormatVersion: "2010-09-09" Parameters: VpcCidrBlock: Type: String Default: "10.0.0.0/16" Environment: Type: String Default: "prod" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: !Ref VpcCidrBlock Tags: - Key: Name Value: !Join [ "-", [ !Ref Environment, "sample", "VPC"]] Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8] Tags: - Key: Name Value: !Join [ "-", [ !Ref Environment, "sample", "subnet"]]

Sub

組み込み関数 - Sub ● 変数に値を置き換える ● プレースホルダー(${ })を使用できる

組み込み関数 - Sub AWSTemplateFormatVersion: "2010-09-09" Parameters: VpcCidrBlock: Type: String Default: "10.0.0.0/16" Environment: Type: String Default: "prd" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: !Ref VpcCidrBlock Tags: - Key: Name Value: !Sub ”${Environment}-sample-VPC" Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8] Tags: - Key: Name Value: !Sub ”${Environment}-sample-subnet"

組み込み関数 - Sub プレースホルダー(${ })はRef関数やGetAtt関数として使用 できる Tags: - Key: Name Value: !Sub ”${Environment}-sample-VPC"

組み込み関数 - JoinとSub JoinとSubって使いどころが似てるな……

組み込み関数 - JoinとSub CloudFormation の組み込み 関数 Fn::Sub 対 Fn::Join | DevelopersIO https://dev.classmethod.jp/a rticles/cloudformation-fnsub -vs-fnjoin/

組み込み関数 - JoinとSub ● 実際使いどころはほぼ同じ ● Serverless frameworkを使用するときはSub関数に注意

まとめ

テンプレートの比較 AWSTemplateFormatVersion: "2010-09-09" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: 10.0.0.0/24 AWSTemplateFormatVersion: "2010-09-09" Parameters: VpcCidrBlock: Type: String Default: "10.0.0.0/16" Environment: Type: String Default: "prod" Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: !Ref VpcCidrBlock Tags: - Key: Name Value: !Join [ "-", [ !Ref Environment, "sample", "VPC"]] Subnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [0, !Cidr !Ref VpcCidrBlock, 1, 8] Tags: - Key: Name Value: !Join [ "-", [ !Ref Environment, "sample", "subnet"]]

まとめ 関数を使って 使い回しができるテンプレートを作成しましょう！

No content