AWS::ECS::Cluster - AWS CloudFormation

AWS::ECS::Cluster

AWS::ECS::Cluster リソースは、Amazon Elastic Container Service (Amazon ECS) クラスターを作成します。

構文

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

JSON

{ "Type" : "AWS::ECS::Cluster", "Properties" : { "CapacityProviders" : [ String, ... ], "ClusterName" : String, "ClusterSettings" : [ ClusterSettings, ... ], "DefaultCapacityProviderStrategy" : [ CapacityProviderStrategyItem, ... ], "Tags" : [ Tag, ... ] } }

プロパティ

CapacityProviders

クラスターに関連付けられているキャパシティープロバイダー。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

ClusterName

クラスターを識別するために使用するユーザー生成文字列。名前を指定しなかった場合は、AWS CloudFormation によって名前の一意の物理 ID が生成されます。

必須: いいえ

タイプ: 文字列

Update requires: Replacement

ClusterSettings

クラスターの作成時に使用する設定。このパラメータは、クラスターの CloudWatch Container Insights を有効にするために使用されます。この値が指定されている場合は、PutAccountSetting または PutAccountSettingDefault で設定されている 値をオーバーライドします。

必須: いいえ

タイプ: ClusterSettingsリスト

Update requires: No interruption

DefaultCapacityProviderStrategy

クラスターのデフォルトのキャパシティープロバイダー戦略。起動タイプまたはキャパシティープロバイダー戦略が指定されていない状態でクラスター内でサービスまたはタスクを実行すると、デフォルトのキャパシティープロバイダー戦略が使用されます。

必須: いいえ

タイプ: CapacityProviderStrategyItem のリスト

Update requires: No interruption

Tags

クラスターに適用し、クラスターの分類と整理に役立つメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で構成されており、どちらもお客様側が定義します。

タグには以下のような基本制限があります。

  • リソースあたりのタグの最大数は 50 です

  • タグキーは、リソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。

  • キーの最大長 - 128 文字 (Unicode) (UTF-8)

  • 値の最大長 - 256 文字 (Unicode) (UTF-8)

  • 複数のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスでも許可される文字に制限が適用されることがあるのでご注意ください。一般的に使用が許可される文字は、UTF-8 で表現できる文字、数字、スペース、および +、-、=、.、_、:、/、@。

  • タグのキーと値は大文字と小文字が区別されます。

  • aws:AWS:、またはその大文字または小文字の組み合わせを、キーまたは値のプレフィックスとして使用しないでください。これらの文字列は AWS による使用のために予約されています。このプレフィックスが含まれるタグのキーや値を編集または削除することはできません。このプレフィックスを持つタグは、リソースあたりのタグ数の制限時には計算されません。

必須: いいえ

タイプ: Tag のリスト

最大: 50

Update requires: No interruption

戻り値

Ref

このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: リソース名。

次の例では、Ref 関数は MyECSCluster クラスターの名前 (MyStack-MyECSCluster-NT5EUXTNTXXD など) を返します。

{ "Ref": "MyECSCluster" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

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

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

Arn

Amazon ECS クラスターの Amazon リソースネーム (ARN) (arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster など)。

Amazon ECS クラスターを作成する

次の例では、MyCluster という名前の空のクラスターを作成します。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "MyCluster": { "Type": "AWS::ECS::Cluster", "Properties": { "ClusterName": "MyCluster" } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Resources: MyCluster: Type: 'AWS::ECS::Cluster' Properties: ClusterName: MyCluster

CloudWatch Container Insights を有効にしたタグを持つ空の Amazon ECS クラスターの作成

次の例では、キー environment と値 production でタグ付けされた CloudWatch Container Insights を有効にした、MyCluster という名前の空のクラスターを作成します。

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "ECSCluster": { "Type": "AWS::ECS::Cluster", "Properties": { "ClusterName": "MyCluster", "ClusterSettings": [ { "Name": "containerInsights", "Value": "enabled" } ], "Tags": [ { "Key": "environment", "Value": "production" } ] } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Resources: ECSCluster: Type: 'AWS::ECS::Cluster' Properties: ClusterName: MyCluster ClusterSettings: - Name: containerInsights Value: enabled Tags: - Key: environment Value: production