/AWS1/CL_EBN=>UPDATEENVIRONMENT()
¶
About UpdateEnvironment¶
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
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.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_APPLICATIONNAME
TYPE /AWS1/EBNAPPLICATIONNAME
/AWS1/EBNAPPLICATIONNAME
¶
The name of the application with which the environment is associated.
IV_ENVIRONMENTID
TYPE /AWS1/EBNENVIRONMENTID
/AWS1/EBNENVIRONMENTID
¶
The ID of the environment to update.
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.
IV_ENVIRONMENTNAME
TYPE /AWS1/EBNENVIRONMENTNAME
/AWS1/EBNENVIRONMENTNAME
¶
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk 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.
IV_GROUPNAME
TYPE /AWS1/EBNGROUPNAME
/AWS1/EBNGROUPNAME
¶
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
IV_DESCRIPTION
TYPE /AWS1/EBNDESCRIPTION
/AWS1/EBNDESCRIPTION
¶
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
IO_TIER
TYPE REF TO /AWS1/CL_EBNENVIRONMENTTIER
/AWS1/CL_EBNENVIRONMENTTIER
¶
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
InvalidParameterValue
error.
IV_VERSIONLABEL
TYPE /AWS1/EBNVERSIONLABEL
/AWS1/EBNVERSIONLABEL
¶
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an
InvalidParameterValue
error.
IV_TEMPLATENAME
TYPE /AWS1/EBNCONFTEMPLATENAME
/AWS1/EBNCONFTEMPLATENAME
¶
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
IV_SOLUTIONSTACKNAME
TYPE /AWS1/EBNSOLUTIONSTACKNAME
/AWS1/EBNSOLUTIONSTACKNAME
¶
This specifies the platform version that the environment will run after the environment is updated.
IV_PLATFORMARN
TYPE /AWS1/EBNPLATFORMARN
/AWS1/EBNPLATFORMARN
¶
The ARN of the platform, if used.
IT_OPTIONSETTINGS
TYPE /AWS1/CL_EBNCONFOPTIONSETTING=>TT_CONFOPTIONSETTINGSLIST
TT_CONFOPTIONSETTINGSLIST
¶
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
IT_OPTIONSTOREMOVE
TYPE /AWS1/CL_EBNOPTIONSPEC=>TT_OPTIONSSPECIFIERLIST
TT_OPTIONSSPECIFIERLIST
¶
A list of custom user-defined configuration options to remove from the configuration set for this environment.