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-describe-configuration-settings

Description

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Syntax

elastic-beanstalk-describe-configuration-settings -a [name] [-t [name] | -e [name]]

Options

NameDescriptionRequired

-a

--application-name name

The application name for the environment or configuration template.

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 describe. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Conditional: You must specify either this parameter or an environment name, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterValue error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Type: String

Default: None

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

Conditional

-e

--environment-name name

The name of the environment to describe.

Type: String

Default: None

Length Constraints: Minimum value of 4. Maximum value of 23.

Conditional

Output

The command returns a table with the following information:

  • ConfigurationSettings—A list of the configuration settings.

Examples

Describing Configuration Settings for an Environment

This example shows how to describe the configuration options for an environment.

PROMPT> elastic-beanstalk-describe-configuration-settings -a MySampleApp -e MySampleAppEnv