true
: The CNAME is available.
true
: The CNAME is not available.
true
: The CNAME is available.
false
: The CNAME is not available.
If no application is found with this name, CreateEnvironment
returns an
InvalidParameterValue
error.
If the specified application has no associated application versions, AWS Elastic Beanstalk
UpdateEnvironment
returns an
InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version.
]]>Constraint: Must be from 4 to 23 characters
in length. The name can
contain only letters, numbers, and hyphens. It cannot start
or end with
a hyphen. This name must be unique in your account.
If the specified
name already exists, AWS Elastic Beanstalk
returns an
InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
]]>InvalidParameterValue
error.
Condition: You must specify either this parameter or a
SolutionStackName
,
but not both.
If you specify both, AWS Elastic Beanstalk
returns an
InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk
returns a
MissingRequiredParameter
error.
Condition: You must specify either this or a
TemplateName
,
but not both.
If you specify both, AWS Elastic Beanstalk
returns an
InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk
returns a
MissingRequiredParameter
error.
SolutionStack
deployed with this environment.
]]>Launching
: Environment is in the process of
initial deployment.
Updating
: Environment is in the process of
updating its configuration settings or
application version.
Ready
: Environment is available to have an action
performed on it, such as update or terminate.
Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs when three or
more
consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong. Occurs when two
consecutive failures occur for an environment.
Green
: Indicates the environment is
healthy and fully functional.
Grey
: Default health for a new environment. The environment
is not fully launched and health checks have not started or health checks
are suspended during an
UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
If no such environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If no such environment is found, RequestEnvironmentInfo
returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
AutoCreateApplication
is
false
, returns an
InvalidParameterValue
error.
]]>Constraint:
Must be unique per application. If an application version already
exists with this label for the specified application, AWS Elastic Beanstalk
returns an
InvalidParameterValue
error.
If data found at the Amazon S3 location exceeds the maximum allowed
source bundle size, AWS Elastic Beanstalk
returns an
InvalidParameterValue
error.
Default:
If not specified, AWS Elastic Beanstalk
uses a sample application.
If only partially specified (for example, a bucket is provided but not
the key)
or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk
returns an
InvalidParameterCombination
error.
true
: Automatically creates the specified application for this
version if it does not already exist.
false
: Returns an
InvalidParameterValue
if the specified application for this version does not already
exist.
true
: Automatically creates the specified application for this
release if it does not already exist.
false
: Throws an
InvalidParameterValue
if the specified application for this release does not already
exist.
Default:
false
Valid Values:
true
|
false
true
: An attempt is made to delete the
associated Amazon S3 source bundle specified at time of creation.
false
: No action is taken on the Amazon S3 source bundle specified at
time of creation.
Valid Values: true
| false
If no application is found with this name, UpdateApplication
returns an
InvalidParameterValue
error.
If no application version is found with this label, UpdateApplication
returns
an
InvalidParameterValue
error.
Constraint: This name must be unique within your account.
If the
specified name already exists, the action returns an
InvalidParameterValue
error.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
.
You may also specify both.
If you specify the SourceEnvironmentId
, you must specify the DestinationEnvironmentId
.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
.
You may also specify both.
If you specify the SourceEnvironmentName
, you must specify the DestinationEnvironmentName
.
Condition: You must specify at least the DestinationEnvironmentID
or the DestinationEnvironmentName
.
You may also specify both.
You must specify the SourceEnvironmentId
with the DestinationEnvironmentId
.
Condition: You must specify at least the DestinationEnvironmentID
or the DestinationEnvironmentName
.
You may also specify both. You must specify the SourceEnvironmentName
with the DestinationEnvironmentName
.
If no application is found with this name, UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
If no configuration template is found with this name, UpdateConfigurationTemplate
returns an
InvalidParameterValue
error.
Constraint: You can remove only UserDefined
configuration options.
null
, the name of the configuration template for this configuration set.
]]>null
, the name of the environment for this configuration set.
]]>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.
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.
If no such environment is found, returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If no such environment is found, returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
UpdateApplication
returns an
InvalidParameterValue
error.
]]>Default: If not specified, AWS Elastic Beanstalk does not update the description.
]]>
true
: Environments that have been deleted after
IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
IncludeDeleted
is set to
true
,
then environments deleted after this date are displayed.
]]>
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
true
: (default) The user AWS resources
(for example, the Auto Scaling group, LoadBalancer, etc.) are terminated
along with the environment.
false
:
The environment is removed from the
AWS Elastic Beanstalk
but the AWS resources continue to operate.
true
: The specified environment as well as the associated
AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
false
: AWS Elastic Beanstalk
resource management is removed from the
environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|
false
SolutionStack
deployed with this environment.
]]>Launching
: Environment is in the process of
initial deployment.
Updating
: Environment is in the process of
updating its configuration settings or
application version.
Ready
: Environment is available to have an action
performed on it, such as update or terminate.
Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs when three or
more
consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong. Occurs when two
consecutive failures occur for an environment.
Green
: Indicates the environment is
healthy and fully functional.
Grey
: Default health for a new environment. The environment
is not fully launched and health checks have not started or health checks
are suspended during an
UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
Condition: You cannot specify both this and an environment name.
]]>Condition: You cannot specify both this and a configuration template name.
]]>
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If no environment with this ID exists, AWS Elastic Beanstalk
returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
InvalidParameterValue
error.
]]>InvalidParameterValue
error.
]]>SolutionStack
deployed with this environment.
]]>Launching
: Environment is in the process of
initial deployment.
Updating
: Environment is in the process of
updating its configuration settings or
application version.
Ready
: Environment is available to have an action
performed on it, such as update or terminate.
Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs when three or
more
consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong. Occurs when two
consecutive failures occur for an environment.
Green
: Indicates the environment is
healthy and fully functional.
Grey
: Default health for a new environment. The environment
is not fully launched and health checks have not started or health checks
are suspended during an
UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
InvalidParameterValue
error.
]]>Constraint: This name must be unique per application.
Default:
If a configuration template
already exists with this name, AWS Elastic Beanstalk
returns an
InvalidParameterValue
error.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
Default: If the
SolutionStackName
is not specified and the source configuration
parameter is blank, AWS Elastic Beanstalk
uses the default solution stack.
If not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
]]>
Values specified in the
OptionSettings
parameter of this call overrides any values obtained
from the
SourceConfiguration
.
If no configuration template is found, returns an
InvalidParameterValue
error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified,
the solution stack of the source
configuration template must match the
specified solution stack name or
else AWS Elastic Beanstalk
returns an
InvalidParameterCombination
error.
null
, the name of the configuration template for this configuration set.
]]>null
, the name of the environment for this configuration set.
]]>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.
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.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
error.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentName, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
EndTime
.
]]>AutoScalingGroup
.
]]>null
, the name of the configuration template for this configuration set.
]]>null
, the name of the environment for this configuration set.
]]>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.
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.
SolutionStack
deployed with this environment.
]]>Launching
: Environment is in the process of
initial deployment.
Updating
: Environment is in the process of
updating its configuration settings or
application version.
Ready
: Environment is available to have an action
performed on it, such as update or terminate.
Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Red
: Indicates the environment is not working.
Yellow
: Indicates that something is wrong, the application
might not be available, but the instances appear running.
Green
: Indicates the environment is
healthy and fully functional.
Red
: Indicates the environment is not responsive. Occurs when three or
more
consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong. Occurs when two
consecutive failures occur for an environment.
Green
: Indicates the environment is
healthy and fully functional.
Grey
: Default health for a new environment. The environment
is not fully launched and health checks have not started or health checks
are suspended during an
UpdateEnvironment
or
RestartEnvironement
request.
Default: Grey
AutoScalingGroups
used by this environment.
]]>AutoScaling
triggers in use by this environment.
]]>NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption
: There is no interruption to the
environment or application availability.
RestartEnvironment
: The environment is entirely
restarted, all AWS resources are deleted and recreated, and
the environment is unavailable during the process.
RestartApplicationServer
: The environment is available
the entire time. However, a short application outage occurs when
the application servers on the running Amazon EC2 instances
are restarted.
true
: This configuration option was defined by the user. It is a
valid choice for specifying this as an Option to Remove when
updating configuration settings.
false
: This configuration was not defined by the user.
true
: This configuration option was defined by the user. It is a
valid choice for specifying if this as an
Option to Remove
when
updating configuration settings.
false
: This configuration was not defined by the user.
Constraint: You can remove only UserDefined
options from a configuration.
Valid Values: true
| false
Scalar
: Values for this option are a single selection from the
possible values, or a unformatted string or numeric value governed
by the MIN/MAX/Regex constraints:
List
: Values for this option are multiple selections of the
possible values.
Boolean
: Values for this option are either
true
or
false
.
Scalar
: Values for this option are a single selection from the
possible values, or an unformatted string, or numeric value governed
by the MIN/MAX/Regex
constraints.
List
: Values for this option are multiple selections from the
possible values.
Boolean
: Values for this option are either
true
or
false
.
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
This location is used to store user log files.
Setting the InfoType
to tail
compiles the last lines from the application server log files of every
Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo
to access the compiled information.
Related Topics
description
) is not provided, the
value remains unchanged. To clear properties,
specify an empty string.
default
and no application versions.
default
configuration template is for a 32-bit version of the
Amazon Linux
operating system running the Tomcat 6 application container.
ApplicationName
) is not provided, its
value remains unchanged. To clear such
properties, specify an empty string.
Related Topics
Related Topics
description
) is not provided, the
value
remains unchanged. To clear these properties, specify an empty string.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
Updating a running environment with any configuration changes creates a
draft configuration set. You can get the draft configuration using
DescribeConfigurationSettings while the update is in progress
or if the update fails. The DeploymentStatus
for the draft
configuration indicates whether the deployment is in process or has failed.
The draft configuration remains in existence until it is deleted with this action.
Attempting to update both the release and configuration is
not allowed and AWS Elastic Beanstalk
returns an
InvalidParameterCombination
error.
When updating the configuration settings to a new template or
individual settings,
a draft configuration is created and
DescribeConfigurationSettings
for this
environment returns two setting descriptions with different
DeploymentStatus
values.
Related Topics
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.
Related Topics
NextToken
.
This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.
AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the lastest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.
Endpoints
AWS Elastic Beanstalk supports the following region-specific endpoint: