AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

ElasticBeanstalk OptionSettings Property Type

OptionSettings is an embedded property of the AWS::ElasticBeanstalk::Application type. It is used by ConfigurationTemplate to specify an array of options for the Elastic Beanstalk configuration described by the template.

Note

You can get the set of valid settings for an Elastic Beanstalk configuration by using the elastic-beanstalk-describe-configuration-settings command. For more information, go to elastic-beanstalk-describe-configuration-settings in the AWS Elastic Beanstalk Developer Guide.

Syntax

{
   "Namespace" : String,
   "OptionName" : String,
   "Value" : String
}     

Members

Namespace

A unique namespace identifying the option's associated AWS resource.

Required: Yes.

Type: String.

OptionName

The name of the configuration option. For a list of options that can be used here, see Option Values in the AWS Elastic Beanstalk Developer Guide

Required: Yes.

Type: String.

Value

The value of the setting.

Required: Yes.

Type: String.

Example

This example of using OptionSettings is found in the AWS CloudFormation sample template: ElasticBeanstalkSample.template, which also provides an example of its use within an AWS::ElasticBeanstalk::Application.

"OptionSettings" : [ {
   "Namespace" : "aws:autoscaling:launchconfiguration",
   "OptionName" : "EC2KeyName",
   "Value" : { "Ref" : "KeyName" }
} ]   

See Also