AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)
« 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...

elastic-beanstalk-update-configuration-template

Description

Updates the specified configuration template to have the specified properties or configuration option values.

Note

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Syntax

elastic-beanstalk-update-configuration-template -a [name] -t [name] -d [desc] -f [filename] -F [filename]

Options

NameDescriptionRequired

-a

--application-name name

The name of the application associated with the configuration template to update. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Type: String

Default: None

Length Constraints: Minimum value of 1. Maximum value of 100.

Yes

-t

--template-name name

The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

Type: String

Default: None

Length Constraints: Minimum value of 1. Maximum value of 100.

Yes

-d

--description desc

A new description for the configuration.

Type: String

Default: None

Length Constraints: Minimum value of 0. Maximum value of 200.

No

-f

--options-file filename

The name of a JSON file that contains option settings to update with the new specified option value.

Type: String

No

-F

--options-to-remove-file value

The name of a JSON file that contains configuration options to remove.

Type: String

Default: None

No

Output

The command returns a table with the following information:

  • ApplicationName—The name of the application associated with this configuration set.

  • DateCreated—The date (in UTC time) when this configuration set was created.

  • DateUpdated—The date (in UTC time) when this configuration set was last modified.

  • DeploymentStatus—If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

    • null: This configuration is not associated with a running environment.

    • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

    • deployed: This is the configuration that is currently deployed to the associated running environment.

    • failed: This is a draft configuration that failed to successfully deploy.

  • Description—The description of the configuration set.

  • EnvironmentName—If not null, the name of the environment for this configuration set.

  • OptionSettings—A list of configuration options and their values in this configuration set.

  • SolutionStackName—The name of the solution stack this configuration set uses.

  • TemplateName—If not null, the name of the configuration template for this configuration set.

Examples

Updating a Configuration Template

This example shows how to update a configuration template. For a list of configuration settings, see Option Values.

PROMPT> elastic-beanstalk-update-configuration-template -a MySampleApp -t myconfigtemplate -d "My updated configuration template" -f "Options.txt"

Options.txt

[
  {"Namespace": "aws:elasticbeanstalk:application:environment",
   "OptionName": "my_custom_param_1",
   "Value": "firstvalue"},
  {"Namespace": "aws:elasticbeanstalk:application:environment",
   "OptionName": "my_custom_param_2",
   "Value": "secondvalue"}
]