メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ElasticBeanstalk::ConfigurationTemplate

Elastic Beanstalk アプリケーションの設定テンプレートを作成します。設定テンプレートを使用すると、設定テンプレートに定義した設定を使用して、アプリケーションの異なるバージョンをデプロイできます。

構文

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

JSON

Copy
{ "Type" : "AWS::ElasticBeanstalk::ConfigurationTemplate", "Properties" : { "ApplicationName" : String, "Description" : String, "EnvironmentId" : String, "OptionSettings" : [ OptionSetting, ... ], "PlatformArn" : String, "SolutionStackName" : String, "SourceConfiguration" : SourceConfiguration } }

YAML

Copy
Type: "AWS::ElasticBeanstalk::ConfigurationTemplate" Properties: ApplicationName: String Description: String EnvironmentId: String OptionSettings: - OptionSetting PlatformArn: String SolutionStackName: String SourceConfiguration: SourceConfiguration

プロパティ

詳細については、『AWS Elastic Beanstalk API リファレンス』の「CreateConfigurationTemplate」を参照してください。

ApplicationName

この設定テンプレートに関連付ける Elastic Beanstalk アプリケーションの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

Description

この設定のオプションの説明。

Type: String

Required: No

更新に伴う要件: 一時的な中断。

EnvironmentId

設定テンプレートを作成するために設定を使用する環境。SolutionStackName プロパティまたは SourceConfiguration プロパティを指定しない場合は、このプロパティを指定する必要があります。

Type: String

Required: Conditional

更新に伴う要件: 置換

OptionSettings

インスタンスタイプなど、この Elastic Beanstalk 設定の OptionSettings のリスト。Elastic Beanstalk 設定オプションの完全な一覧については、AWS Elastic Beanstalk 開発者ガイドの「オプション値」を参照してください。

OptionSettingType: リスト。

Required: No

更新に伴う要件: 一時的な中断。

PlatformArn

カスタムプラットフォームの Amazon リソースネーム (ARN)。詳細については、『AWS Elastic Beanstalk 開発者ガイド』の「カスタムプラットフォーム」を参照してください。

注記

PlatformArn を指定した場合は、SolutionStackName を指定しないでください。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

SolutionStackName

この設定で使用する Elastic Beanstalk ソリューションスタックの名前。ソリューションスタックでは、設定テンプレートのオペレーティングシステム、アーキテクチャー、アプリケーションサーバーを指定します (例: 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7)。詳細については、AWS Elastic Beanstalk 開発者ガイドの「サポートされているプラットフォーム」を参照してください。

PlatformArn プロパティ、EnvironmentId プロパティ、または SourceConfiguration プロパティを指定しない場合は、次のプロパティを指定する必要があります。

Type: String

Required: Conditional

更新に伴う要件: 置換

SourceConfiguration

別の Elastic Beanstalk アプリケーションに関連付けられる設定テンプレート。SolutionStackName プロパティと SourceConfiguration プロパティを指定した場合、ソース設定テンプレートのソリューションスタックは、SolutionStackName プロパティに対して指定した値と一致する必要があります。

EnvironmentId プロパティまたは SolutionStackName プロパティを指定しない場合は、このプロパティを指定する必要があります。

タイプ: Elastic Beanstalk SourceConfiguration プロパティタイプ

Required: Conditional

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。

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

この ElasticBeanstalk ConfigurationTemplate の例は、AWS CloudFormation サンプルテンプレートの ElasticBeanstalkSample.template に含まれています。このサンプルテンプレートには、AWS::ElasticBeanstalk::Application 内での使用例も含まれています。

JSON

Copy
"myConfigTemplate" : { "Type" : "AWS::ElasticBeanstalk::ConfigurationTemplate", "Properties" : { "ApplicationName" :{"Ref" : "myApp"}, "Description" : "my sample configuration template", "EnvironmentId" : "", "SourceConfiguration" : { "ApplicationName" : {"Ref" : "mySecondApp"}, "TemplateName" : {"Ref" : "mySourceTemplate"} }, "SolutionStackName" : "64bit Amazon Linux running PHP 5.3", "OptionSettings" : [ { "Namespace" : "aws:autoscaling:launchconfiguration", "OptionName" : "EC2KeyName", "Value" : { "Ref" : "KeyName" } } ] } }

YAML

Copy
myConfigTemplate: Type: "AWS::ElasticBeanstalk::ConfigurationTemplate" Properties: ApplicationName: Ref: "myApp" Description: "my sample configuration template" EnvironmentId: "" SourceConfiguration: ApplicationName: Ref: "mySecondApp" TemplateName: Ref: "mySourceTemplate" SolutionStackName: "64bit Amazon Linux running PHP 5.3" OptionSettings: - Namespace: "aws:autoscaling:launchconfiguration" OptionName: "EC2KeyName" Value: Ref: "KeyName"

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