baiji v0.6.5 Baiji.ElasticBeanstalk

AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Cancels in-progress environment configuration update or application version deployment

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions

Checks if the specified CNAME is available

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details

Creates an application that has one configuration template named default and no application versions

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings

Launches an environment for the specified application using the specified configuration

Create a new version of your custom platform

Creates the Amazon S3 storage location for the account

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket

Deletes the specified version from the specified application

Deletes the specified configuration template

Deletes the draft configuration associated with the running environment

Deletes the specified version of a custom platform

Retrieve a list of application versions

Returns the descriptions of existing applications

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed

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

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health

Lists an environment’s completed and failed managed actions

Lists an environment’s upcoming and in-progress managed actions

Returns AWS resources for this environment

Returns descriptions for existing environments

Returns list of event descriptions matching criteria up to the last 6 weeks

Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting

Describes the version of the platform

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart

Initiates a request to compile the specified type of information of the deployed environment

Causes the environment to restart the application container server running on each Amazon EC2 instance

Retrieves the compiled information from a RequestEnvironmentInfo request

Swaps the CNAMEs of two environments

Terminates the specified environment

Updates the specified application to have the specified properties

Modifies lifecycle settings for an application

Updates the specified application version to have the specified properties

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

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

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function abort_environment_update(input \\ %{}, options \\ [])

Cancels in-progress environment configuration update or application version deployment.

Link to this function apply_environment_managed_action(input \\ %{}, options \\ [])

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

Link to this function check_d_n_s_availability(input \\ %{}, options \\ [])

Checks if the specified CNAME is available.

Link to this function compose_environments(input \\ %{}, options \\ [])

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

Link to this function create_application(input \\ %{}, options \\ [])

Creates an application that has one configuration template named default and no application versions.

Link to this function create_application_version(input \\ %{}, options \\ [])

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Link to this function create_configuration_template(input \\ %{}, options \\ [])

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

  • `DescribeConfigurationOptions`
  • `DescribeConfigurationSettings`
  • `ListAvailableSolutionStacks`
Link to this function create_environment(input \\ %{}, options \\ [])

Launches an environment for the specified application using the specified configuration.

Link to this function create_platform_version(input \\ %{}, options \\ [])

Create a new version of your custom platform.

Link to this function create_storage_location(input \\ %{}, options \\ [])

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Link to this function delete_application(input \\ %{}, options \\ [])

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.
Link to this function delete_application_version(input \\ %{}, options \\ [])

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.
Link to this function delete_configuration_template(input \\ %{}, options \\ [])

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
Link to this function delete_environment_configuration(input \\ %{}, options \\ [])

Deletes the draft configuration associated with the running environment.

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.

Link to this function delete_platform_version(input \\ %{}, options \\ [])

Deletes the specified version of a custom platform.

Link to this function describe_application_versions(input \\ %{}, options \\ [])

Retrieve a list of application versions.

Link to this function describe_applications(input \\ %{}, options \\ [])

Returns the descriptions of existing applications.

Link to this function describe_configuration_options(input \\ %{}, options \\ [])

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Link to this function describe_configuration_settings(input \\ %{}, options \\ [])

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.

Related Topics

  • `DeleteEnvironmentConfiguration`
Link to this function describe_environment_health(input \\ %{}, options \\ [])

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Link to this function describe_environment_managed_action_history(input \\ %{}, options \\ [])

Lists an environment’s completed and failed managed actions.

Link to this function describe_environment_managed_actions(input \\ %{}, options \\ [])

Lists an environment’s upcoming and in-progress managed actions.

Link to this function describe_environment_resources(input \\ %{}, options \\ [])

Returns AWS resources for this environment.

Link to this function describe_environments(input \\ %{}, options \\ [])

Returns descriptions for existing environments.

Link to this function describe_events(input \\ %{}, options \\ [])

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified `NextToken`.
Link to this function describe_instances_health(input \\ %{}, options \\ [])

Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Link to this function describe_platform_version(input \\ %{}, options \\ [])

Describes the version of the platform.

Link to this function list_available_solution_stacks(input \\ %{}, options \\ [])

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Link to this function list_platform_versions(input \\ %{}, options \\ [])

Lists the available platforms.

Link to this function rebuild_environment(input \\ %{}, options \\ [])

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

Link to this function request_environment_info(input \\ %{}, options \\ [])

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

  • `RetrieveEnvironmentInfo`
Link to this function restart_app_server(input \\ %{}, options \\ [])

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Link to this function retrieve_environment_info(input \\ %{}, options \\ [])

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

  • `RequestEnvironmentInfo`
Link to this function swap_environment_c_n_a_m_es(input \\ %{}, options \\ [])

Swaps the CNAMEs of two environments.

Link to this function terminate_environment(input \\ %{}, options \\ [])

Terminates the specified environment.

Link to this function update_application(input \\ %{}, options \\ [])

Updates the specified application to have the specified properties.

If a property (for example, `description`) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Link to this function update_application_resource_lifecycle(input \\ %{}, options \\ [])

Modifies lifecycle settings for an application.

Link to this function update_application_version(input \\ %{}, options \\ [])

Updates the specified application version to have the specified properties.

If a property (for example, `description`) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Link to this function update_configuration_template(input \\ %{}, options \\ [])

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

If a property (for example, `ApplicationName`) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics
  • `DescribeConfigurationOptions`
Link to this function update_environment(input \\ %{}, options \\ [])

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.

Link to this function validate_configuration_settings(input \\ %{}, options \\ [])

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.