AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::EKS::Cluster

AWS::EKS::Cluster リソースは、Amazon EKS クラスターコントロールプレーンを作成します。Amazon EKS クラスターコントロールプレーンは、etcd および Kubernetes API server などの Kubernetes ソフトウェアを実行するコントロールプレーンインスタンスで構成されています。コントロールプレーンは AWS によって管理されるアカウントで実行され、Kubernetes API はクラスターに関連付けられている Amazon EKS エンドポイントを使用して公開されます。詳細については、Amazon EKS ユーザーガイド の「クラスター」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::EKS::Cluster", "Properties" : { "Name" : String, "ResourcesVpcConfig" : EKS クラスター ResourcesVpcConfig, "RoleArn" : String, "Version" : String } }

YAML

Type: "AWS::EKS::Cluster" Properties: Name: String ResourcesVpcConfig: EKS クラスター ResourcesVpcConfig RoleArn: String Version: String

プロパティ

Name

クラスターの名前。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

ResourcesVpcConfig

クラスタコントロールプレーンで使用される VPC サブネットとセキュリティグループ。Amazon EKS VPC のリソースには、Kubernetes で適切に動作するための特定の要件があります。詳細については、Amazon EKS ユーザーガイド の「クラスター VPC に関する考慮事項」および「クラスターセキュリティグループの考慮事項」を参照してください。

必須: はい

タイプ: EKS クラスター ResourcesVpcConfig

更新に伴う要件: 置換。

RoleArn

IAM ロールの Amazon リソースネーム (ARN)。Kubernetes コントロールプレーンが AWS API オペレーションを呼び出すためのアクセス権限を提供します。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換。

Version

クラスターのバージョンの Kubernetes サーバーです。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

戻り値

参照番号

AWS::EKS::Cluster リソースの論理 ID を組み込み Ref 関数に渡すと、クラスターの名前 (EKSCluster-NT5EUXTNTXXD など) が関数より返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Arn

のクラスターの ARN、arn:aws:eks:us-west-2:666666666666:cluster/prod など。

CertificateAuthorityData

クラスターの certificate-authority-data

Endpoint

Kubernetes API サーバーのエンドポイント、https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com など。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

クラスターを作成する

次の例では、prodという Amazon EKS クラスターを作成します。

JSON

{ "Type": "AWS::EKS::Cluster", "Properties": { "Name": "prod", "Version": "1.10", "RoleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-EXAMPLEBQ4PI", "ResourcesVpcConfig": { "SecurityGroupIds": [ "sg-6979fe18" ], "SubnetIds": [ "subnet-6782e71e", "subnet-e7e761ac" ] } } }

YAML

Type: "AWS::EKS::Cluster" Properties: Name: "prod" Version: "1.10" RoleArn: "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-EXAMPLEBQ4PI" ResourcesVpcConfig: SecurityGroupIds: ["sg-6979fe18"] SubnetIds: ["subnet-6782e71e", "subnet-e7e761ac"]

以下の資料も参照してください。