Class: Aws::ElasticBeanstalk::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElasticBeanstalk::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb
Overview
An API client for ElasticBeanstalk. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ElasticBeanstalk::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#abort_environment_update(params = {}) ⇒ Struct
Cancels in-progress environment configuration update or application version deployment.
-
#apply_environment_managed_action(params = {}) ⇒ Types::ApplyEnvironmentManagedActionResult
Applies a scheduled managed action immediately.
-
#associate_environment_operations_role(params = {}) ⇒ Struct
Add or change the operations role used by an environment.
-
#check_dns_availability(params = {}) ⇒ Types::CheckDNSAvailabilityResultMessage
Checks if the specified CNAME is available.
-
#compose_environments(params = {}) ⇒ Types::EnvironmentDescriptionsMessage
Create or update a group of environments that each run a separate component of a single application.
-
#create_application(params = {}) ⇒ Types::ApplicationDescriptionMessage
Creates an application that has one configuration template named
default
and no application versions. -
#create_application_version(params = {}) ⇒ Types::ApplicationVersionDescriptionMessage
Creates an application version for the specified application.
-
#create_configuration_template(params = {}) ⇒ Types::ConfigurationSettingsDescription
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.
-
#create_environment(params = {}) ⇒ Types::EnvironmentDescription
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
-
#create_platform_version(params = {}) ⇒ Types::CreatePlatformVersionResult
Create a new version of your custom platform.
-
#create_storage_location(params = {}) ⇒ Types::CreateStorageLocationResultMessage
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.
-
#delete_application(params = {}) ⇒ Struct
Deletes the specified application along with all associated versions and configurations.
-
#delete_application_version(params = {}) ⇒ Struct
Deletes the specified version from the specified application.
-
#delete_configuration_template(params = {}) ⇒ Struct
Deletes the specified configuration template.
-
#delete_environment_configuration(params = {}) ⇒ Struct
Deletes the draft configuration associated with the running environment.
-
#delete_platform_version(params = {}) ⇒ Types::DeletePlatformVersionResult
Deletes the specified version of a custom platform.
-
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
-
#describe_application_versions(params = {}) ⇒ Types::ApplicationVersionDescriptionsMessage
Retrieve a list of application versions.
-
#describe_applications(params = {}) ⇒ Types::ApplicationDescriptionsMessage
Returns the descriptions of existing applications.
-
#describe_configuration_options(params = {}) ⇒ Types::ConfigurationOptionsDescription
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
-
#describe_configuration_settings(params = {}) ⇒ Types::ConfigurationSettingsDescriptions
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.
-
#describe_environment_health(params = {}) ⇒ Types::DescribeEnvironmentHealthResult
Returns information about the overall health of the specified environment.
-
#describe_environment_managed_action_history(params = {}) ⇒ Types::DescribeEnvironmentManagedActionHistoryResult
Lists an environment's completed and failed managed actions.
-
#describe_environment_managed_actions(params = {}) ⇒ Types::DescribeEnvironmentManagedActionsResult
Lists an environment's upcoming and in-progress managed actions.
-
#describe_environment_resources(params = {}) ⇒ Types::EnvironmentResourceDescriptionsMessage
Returns AWS resources for this environment.
-
#describe_environments(params = {}) ⇒ Types::EnvironmentDescriptionsMessage
Returns descriptions for existing environments.
-
#describe_events(params = {}) ⇒ Types::EventDescriptionsMessage
Returns list of event descriptions matching criteria up to the last 6 weeks.
-
#describe_instances_health(params = {}) ⇒ Types::DescribeInstancesHealthResult
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.
-
#describe_platform_version(params = {}) ⇒ Types::DescribePlatformVersionResult
Describes a platform version.
-
#disassociate_environment_operations_role(params = {}) ⇒ Struct
Disassociate the operations role from an environment.
-
#list_available_solution_stacks(params = {}) ⇒ Types::ListAvailableSolutionStacksResultMessage
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
-
#list_platform_branches(params = {}) ⇒ Types::ListPlatformBranchesResult
Lists the platform branches available for your account in an AWS Region.
-
#list_platform_versions(params = {}) ⇒ Types::ListPlatformVersionsResult
Lists the platform versions available for your account in an AWS Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ResourceTagsDescriptionMessage
Return the tags applied to an AWS Elastic Beanstalk resource.
-
#rebuild_environment(params = {}) ⇒ Struct
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.
-
#request_environment_info(params = {}) ⇒ Struct
Initiates a request to compile the specified type of information of the deployed environment.
-
#restart_app_server(params = {}) ⇒ Struct
Causes the environment to restart the application container server running on each Amazon EC2 instance.
-
#retrieve_environment_info(params = {}) ⇒ Types::RetrieveEnvironmentInfoResultMessage
Retrieves the compiled information from a RequestEnvironmentInfo request.
-
#swap_environment_cnames(params = {}) ⇒ Struct
Swaps the CNAMEs of two environments.
-
#terminate_environment(params = {}) ⇒ Types::EnvironmentDescription
Terminates the specified environment.
-
#update_application(params = {}) ⇒ Types::ApplicationDescriptionMessage
Updates the specified application to have the specified properties.
-
#update_application_resource_lifecycle(params = {}) ⇒ Types::ApplicationResourceLifecycleDescriptionMessage
Modifies lifecycle settings for an application.
-
#update_application_version(params = {}) ⇒ Types::ApplicationVersionDescriptionMessage
Updates the specified application version to have the specified properties.
-
#update_configuration_template(params = {}) ⇒ Types::ConfigurationSettingsDescription
Updates the specified configuration template to have the specified properties or configuration option values.
-
#update_environment(params = {}) ⇒ Types::EnvironmentDescription
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.
-
#update_tags_for_resource(params = {}) ⇒ Struct
Update the list of tags applied to an AWS Elastic Beanstalk resource.
-
#validate_configuration_settings(params = {}) ⇒ Types::ConfigurationSettingsValidationMessages
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#abort_environment_update(params = {}) ⇒ Struct
Cancels in-progress environment configuration update or application version deployment.
448 449 450 451 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 448 def abort_environment_update(params = {}, = {}) req = build_request(:abort_environment_update, params) req.send_request() end |
#apply_environment_managed_action(params = {}) ⇒ Types::ApplyEnvironmentManagedActionResult
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.
492 493 494 495 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 492 def apply_environment_managed_action(params = {}, = {}) req = build_request(:apply_environment_managed_action, params) req.send_request() end |
#associate_environment_operations_role(params = {}) ⇒ Struct
Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
527 528 529 530 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 527 def associate_environment_operations_role(params = {}, = {}) req = build_request(:associate_environment_operations_role, params) req.send_request() end |
#check_dns_availability(params = {}) ⇒ Types::CheckDNSAvailabilityResultMessage
Checks if the specified CNAME is available.
572 573 574 575 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 572 def check_dns_availability(params = {}, = {}) req = build_request(:check_dns_availability, params) req.send_request() end |
#compose_environments(params = {}) ⇒ Types::EnvironmentDescriptionsMessage
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.
660 661 662 663 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 660 def compose_environments(params = {}, = {}) req = build_request(:compose_environments, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::ApplicationDescriptionMessage
Creates an application that has one configuration template named
default
and no application versions.
762 763 764 765 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 762 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_application_version(params = {}) ⇒ Types::ApplicationVersionDescriptionMessage
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.
939 940 941 942 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 939 def create_application_version(params = {}, = {}) req = build_request(:create_application_version, params) req.send_request() end |
#create_configuration_template(params = {}) ⇒ Types::ConfigurationSettingsDescription
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The
EnvironmentName
response element is always null
.
Related Topics
DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks
1124 1125 1126 1127 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1124 def create_configuration_template(params = {}, = {}) req = build_request(:create_configuration_template, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::EnvironmentDescription
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1378 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_platform_version(params = {}) ⇒ Types::CreatePlatformVersionResult
Create a new version of your custom platform.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1460 def create_platform_version(params = {}, = {}) req = build_request(:create_platform_version, params) req.send_request() end |
#create_storage_location(params = {}) ⇒ Types::CreateStorageLocationResultMessage
Creates a bucket in Amazon S3 to store application versions, logs, and
other files used by Elastic Beanstalk environments. The Elastic
Beanstalk console and EB CLI call this API the first time you create
an environment in a region. If the storage location already exists,
CreateStorageLocation
still returns the bucket name but does not
create a new bucket.
1497 1498 1499 1500 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1497 def create_storage_location(params = {}, = {}) req = build_request(:create_storage_location, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
1539 1540 1541 1542 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1539 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_application_version(params = {}) ⇒ Struct
Deletes the specified version from the specified application.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1587 def delete_application_version(params = {}, = {}) req = build_request(:delete_application_version, params) req.send_request() end |
#delete_configuration_template(params = {}) ⇒ Struct
Deletes the specified configuration template.
1630 1631 1632 1633 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1630 def delete_configuration_template(params = {}, = {}) req = build_request(:delete_configuration_template, params) req.send_request() end |
#delete_environment_configuration(params = {}) ⇒ Struct
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.
1675 1676 1677 1678 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1675 def delete_environment_configuration(params = {}, = {}) req = build_request(:delete_environment_configuration, params) req.send_request() end |
#delete_platform_version(params = {}) ⇒ Types::DeletePlatformVersionResult
Deletes the specified version of a custom platform.
1716 1717 1718 1719 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1716 def delete_platform_version(params = {}, = {}) req = build_request(:delete_platform_version, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
The result currently has one set of attributes—resource quotas.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1742 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_application_versions(params = {}) ⇒ Types::ApplicationVersionDescriptionsMessage
Retrieve a list of application versions.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1846 def describe_application_versions(params = {}, = {}) req = build_request(:describe_application_versions, params) req.send_request() end |
#describe_applications(params = {}) ⇒ Types::ApplicationDescriptionsMessage
Returns the descriptions of existing applications.
1937 1938 1939 1940 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 1937 def describe_applications(params = {}, = {}) req = build_request(:describe_applications, params) req.send_request() end |
#describe_configuration_options(params = {}) ⇒ Types::ConfigurationOptionsDescription
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.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2054 def (params = {}, = {}) req = build_request(:describe_configuration_options, params) req.send_request() end |
#describe_configuration_settings(params = {}) ⇒ Types::ConfigurationSettingsDescriptions
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
^
2180 2181 2182 2183 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2180 def describe_configuration_settings(params = {}, = {}) req = build_request(:describe_configuration_settings, params) req.send_request() end |
#describe_environment_health(params = {}) ⇒ Types::DescribeEnvironmentHealthResult
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2311 def describe_environment_health(params = {}, = {}) req = build_request(:describe_environment_health, params) req.send_request() end |
#describe_environment_managed_action_history(params = {}) ⇒ Types::DescribeEnvironmentManagedActionHistoryResult
Lists an environment's completed and failed managed actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2363 2364 2365 2366 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2363 def describe_environment_managed_action_history(params = {}, = {}) req = build_request(:describe_environment_managed_action_history, params) req.send_request() end |
#describe_environment_managed_actions(params = {}) ⇒ Types::DescribeEnvironmentManagedActionsResult
Lists an environment's upcoming and in-progress managed actions.
2404 2405 2406 2407 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2404 def describe_environment_managed_actions(params = {}, = {}) req = build_request(:describe_environment_managed_actions, params) req.send_request() end |
#describe_environment_resources(params = {}) ⇒ Types::EnvironmentResourceDescriptionsMessage
Returns AWS resources for this environment.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2499 def describe_environment_resources(params = {}, = {}) req = build_request(:describe_environment_resources, params) req.send_request() end |
#describe_environments(params = {}) ⇒ Types::EnvironmentDescriptionsMessage
Returns descriptions for existing environments.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- environment_exists
- environment_terminated
- environment_updated
2649 2650 2651 2652 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2649 def describe_environments(params = {}, = {}) req = build_request(:describe_environments, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::EventDescriptionsMessage
Returns list of event descriptions matching criteria up to the last 6 weeks.
NextToken
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2801 2802 2803 2804 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2801 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_instances_health(params = {}) ⇒ Types::DescribeInstancesHealthResult
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 2952 def describe_instances_health(params = {}, = {}) req = build_request(:describe_instances_health, params) req.send_request() end |
#describe_platform_version(params = {}) ⇒ Types::DescribePlatformVersionResult
Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3017 def describe_platform_version(params = {}, = {}) req = build_request(:describe_platform_version, params) req.send_request() end |
#disassociate_environment_operations_role(params = {}) ⇒ Struct
Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
3048 3049 3050 3051 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3048 def disassociate_environment_operations_role(params = {}, = {}) req = build_request(:disassociate_environment_operations_role, params) req.send_request() end |
#list_available_solution_stacks(params = {}) ⇒ Types::ListAvailableSolutionStacksResultMessage
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
3125 3126 3127 3128 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3125 def list_available_solution_stacks(params = {}, = {}) req = build_request(:list_available_solution_stacks, params) req.send_request() end |
#list_platform_branches(params = {}) ⇒ Types::ListPlatformBranchesResult
Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.
For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3226 def list_platform_branches(params = {}, = {}) req = build_request(:list_platform_branches, params) req.send_request() end |
#list_platform_versions(params = {}) ⇒ Types::ListPlatformVersionsResult
Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3302 3303 3304 3305 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3302 def list_platform_versions(params = {}, = {}) req = build_request(:list_platform_versions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ResourceTagsDescriptionMessage
Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
3346 3347 3348 3349 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3346 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#rebuild_environment(params = {}) ⇒ Struct
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.
3391 3392 3393 3394 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3391 def rebuild_environment(params = {}, = {}) req = build_request(:rebuild_environment, params) req.send_request() end |
#request_environment_info(params = {}) ⇒ Struct
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
^
3462 3463 3464 3465 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3462 def request_environment_info(params = {}, = {}) req = build_request(:request_environment_info, params) req.send_request() end |
#restart_app_server(params = {}) ⇒ Struct
Causes the environment to restart the application container server running on each Amazon EC2 instance.
3506 3507 3508 3509 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3506 def restart_app_server(params = {}, = {}) req = build_request(:restart_app_server, params) req.send_request() end |
#retrieve_environment_info(params = {}) ⇒ Types::RetrieveEnvironmentInfoResultMessage
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
- RequestEnvironmentInfo
^
3589 3590 3591 3592 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3589 def retrieve_environment_info(params = {}, = {}) req = build_request(:retrieve_environment_info, params) req.send_request() end |
#swap_environment_cnames(params = {}) ⇒ Struct
Swaps the CNAMEs of two environments.
3652 3653 3654 3655 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3652 def swap_environment_cnames(params = {}, = {}) req = build_request(:swap_environment_cnames, params) req.send_request() end |
#terminate_environment(params = {}) ⇒ Types::EnvironmentDescription
Terminates the specified environment.
3796 3797 3798 3799 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3796 def terminate_environment(params = {}, = {}) req = build_request(:terminate_environment, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::ApplicationDescriptionMessage
Updates the specified application to have the specified properties.
description
) is not provided, the value
remains unchanged. To clear these properties, specify an empty string.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3881 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_application_resource_lifecycle(params = {}) ⇒ Types::ApplicationResourceLifecycleDescriptionMessage
Modifies lifecycle settings for an application.
3935 3936 3937 3938 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 3935 def update_application_resource_lifecycle(params = {}, = {}) req = build_request(:update_application_resource_lifecycle, params) req.send_request() end |
#update_application_version(params = {}) ⇒ Types::ApplicationVersionDescriptionMessage
Updates the specified application version to have the specified properties.
description
) is not provided, the value
remains unchanged. To clear properties, specify an empty string.
4021 4022 4023 4024 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4021 def update_application_version(params = {}, = {}) req = build_request(:update_application_version, params) req.send_request() end |
#update_configuration_template(params = {}) ⇒ Types::ConfigurationSettingsDescription
Updates the specified configuration template to have the specified properties or configuration option values.
ApplicationName
) is not provided, its
value remains unchanged. To clear such properties, specify an empty
string.
Related Topics
- DescribeConfigurationOptions
^
4151 4152 4153 4154 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4151 def update_configuration_template(params = {}, = {}) req = build_request(:update_configuration_template, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::EnvironmentDescription
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.
4414 4415 4416 4417 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4414 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |
#update_tags_for_resource(params = {}) ⇒ Struct
Update the list of tags applied to an AWS Elastic Beanstalk resource.
Two lists can be passed: TagsToAdd
for tags to add or update, and
TagsToRemove
.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:
- elasticbeanstalk:AddTags
Controls permission to call
UpdateTagsForResource
and pass a list of tags to add in theTagsToAdd
parameter.- elasticbeanstalk:RemoveTags
Controls permission to call
UpdateTagsForResource
and pass a list of tag keys to remove in theTagsToRemove
parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
4485 4486 4487 4488 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4485 def (params = {}, = {}) req = build_request(:update_tags_for_resource, params) req.send_request() end |
#validate_configuration_settings(params = {}) ⇒ Types::ConfigurationSettingsValidationMessages
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.
4571 4572 4573 4574 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4571 def validate_configuration_settings(params = {}, = {}) req = build_request(:validate_configuration_settings, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
environment_exists | #describe_environments | 20 | 20 |
environment_terminated | #describe_environments | 20 | 20 |
environment_updated | #describe_environments | 20 | 20 |
4683 4684 4685 4686 4687 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/client.rb', line 4683 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |