(constructor)

[configuration]

Constructs a new instance of the <code>ElasticBeanstalkClient</code> class

config

The resolved configuration of ElasticBeanstalkClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-elastic-beanstalk!ElasticBeanstalkClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

ElasticBeanstalkClient

<fullname>AWS Elastic Beanstalk</fullname> 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 <a href="http://aws.amazon.com/elasticbeanstalk/">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href="https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl">https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. 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 <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>. Endpoints For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region">Regions and Endpoints</a> in the Amazon Web Services Glossary.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

profile

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AbortEnvironmentUpdateCommand

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

ApplyEnvironmentManagedActionCommand

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

AssociateEnvironmentOperationsRoleCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html">Operations roles</a> in the AWS Elastic Beanstalk Developer Guide.

CheckDNSAvailabilityCommand

Checks if the specified CNAME is available.

ComposeEnvironmentsCommand

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 <code>env.yaml</code>. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html">Compose Environments</a> for details.

CreateApplicationCommand

Creates an application that has one configuration template named <code>default</code> and no application versions.

CreateApplicationVersionCommand

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 <code>SourceBuildInformation</code>. Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and <code>BuildConfiguration</code>. Specify a source bundle in S3 with <code>SourceBundle</code> Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample application. <note> After you create an application version with a specified Amazon S3 bucket and key location, you can't 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. </note>

CreateConfigurationTemplateCommand

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 <code>EnvironmentName</code> response element is always <code>null</code>. Related Topics <ul> <li> DescribeConfigurationOptions </li> <li> DescribeConfigurationSettings </li> <li> ListAvailableSolutionStacks </li> </ul>

CreateEnvironmentCommand

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

CreatePlatformVersionCommand

Create a new version of your custom platform.

CreateStorageLocationCommand

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, <code>CreateStorageLocation</code> still returns the bucket name but does not create a new bucket.

DeleteApplicationCommand

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. <note> You cannot delete an application that has a running environment. </note>

DeleteApplicationVersionCommand

Deletes the specified version from the specified application. <note> You cannot delete an application version that is associated with a running environment. </note>

DeleteConfigurationTemplateCommand

Deletes the specified configuration template. <note> 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. </note>

DeleteEnvironmentConfigurationCommand

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 <code>DeploymentStatus</code> 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.

DeletePlatformVersionCommand

Deletes the specified version of a custom platform.

DescribeAccountAttributesCommand

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.

DescribeApplicationVersionsCommand

Retrieve a list of application versions.

DescribeApplicationsCommand

Returns the descriptions of existing applications.

DescribeConfigurationOptionsCommand

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.

DescribeConfigurationSettingsCommand

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 <ul> <li> DeleteEnvironmentConfiguration </li> </ul>

DescribeEnvironmentHealthCommand

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

DescribeEnvironmentManagedActionHistoryCommand

Lists an environment's completed and failed managed actions.

DescribeEnvironmentManagedActionsCommand

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

DescribeEnvironmentResourcesCommand

Returns AWS resources for this environment.

DescribeEnvironmentsCommand

Returns descriptions for existing environments.

DescribeEventsCommand

Returns list of event descriptions matching criteria up to the last 6 weeks. <note> This action returns the most recent 1,000 events from the specified <code>NextToken</code>. </note>

DescribeInstancesHealthCommand

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html">enhanced health reporting</a>.

DescribePlatformVersionCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html">AWS Elastic Beanstalk Platforms Glossary</a>.

DisassociateEnvironmentOperationsRoleCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html">Operations roles</a> in the AWS Elastic Beanstalk Developer Guide.

ListAvailableSolutionStacksCommand

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

ListPlatformBranchesCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html">AWS Elastic Beanstalk Platforms Glossary</a>.

ListPlatformVersionsCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html">AWS Elastic Beanstalk Platforms Glossary</a>.

ListTagsForResourceCommand

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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html">Tagging Application Resources</a>.

RebuildEnvironmentCommand

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.

RequestEnvironmentInfoCommand

Initiates a request to compile the specified type of information of the deployed environment. Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics <ul> <li> RetrieveEnvironmentInfo </li> </ul>

RestartAppServerCommand

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

RetrieveEnvironmentInfoCommand

Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics <ul> <li> RequestEnvironmentInfo </li> </ul>

SwapEnvironmentCNAMEsCommand

Swaps the CNAMEs of two environments.

TerminateEnvironmentCommand

Terminates the specified environment.

UpdateApplicationCommand

Updates the specified application to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string. </note>

UpdateApplicationResourceLifecycleCommand

Modifies lifecycle settings for an application.

UpdateApplicationVersionCommand

Updates the specified application version to have the specified properties. <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string. </note>

UpdateConfigurationTemplateCommand

Updates the specified configuration template to have the specified properties or configuration option values. <note> If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string. </note> Related Topics <ul> <li> DescribeConfigurationOptions </li> </ul>

UpdateEnvironmentCommand

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 <code>InvalidParameterCombination</code> 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 <code>DeploymentStatus</code> values.

UpdateTagsForResourceCommand

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>. Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html">Tagging Application Resources</a>. 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: <dl> <dt>elasticbeanstalk:AddTags</dt> <dd> Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code> parameter. </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd> Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code> parameter. </dd> </dl> For details about creating a custom user policy, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies">Creating a Custom User Policy</a>.

ValidateConfigurationSettingsCommand

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.