AbstractAWSElasticBeanstalk (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticbeanstalk.AbstractAWSElasticBeanstalk

All Implemented Interfaces:

AWSElasticBeanstalk

Direct Known Subclasses:

AbstractAWSElasticBeanstalkAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSElasticBeanstalk
extends Object
implements AWSElasticBeanstalk
```
Abstract implementation of AWSElasticBeanstalk. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbortEnvironmentUpdateResult`	`abortEnvironmentUpdate()` Simplified method form for invoking the AbortEnvironmentUpdate operation.
`AbortEnvironmentUpdateResult`	`abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)` Cancels in-progress environment configuration update or application version deployment.
`ApplyEnvironmentManagedActionResult`	`applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest request)` Applies a scheduled managed action immediately.
`CheckDNSAvailabilityResult`	`checkDNSAvailability(CheckDNSAvailabilityRequest request)` Checks if the specified CNAME is available.
`ComposeEnvironmentsResult`	`composeEnvironments(ComposeEnvironmentsRequest request)` Create or update a group of environments that each run a separate component of a single application.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest request)` Creates an application that has one configuration template named `default` and no application versions.
`CreateApplicationVersionResult`	`createApplicationVersion(CreateApplicationVersionRequest request)` Creates an application version for the specified application.
`CreateConfigurationTemplateResult`	`createConfigurationTemplate(CreateConfigurationTemplateRequest request)` Creates a configuration template.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest request)` Launches an environment for the specified application using the specified configuration.
`CreatePlatformVersionResult`	`createPlatformVersion(CreatePlatformVersionRequest request)` Create a new version of your custom platform.
`CreateStorageLocationResult`	`createStorageLocation()` Simplified method form for invoking the CreateStorageLocation operation.
`CreateStorageLocationResult`	`createStorageLocation(CreateStorageLocationRequest request)` Creates the Amazon S3 storage location for the account.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes the specified application along with all associated versions and configurations.
`DeleteApplicationVersionResult`	`deleteApplicationVersion(DeleteApplicationVersionRequest request)` Deletes the specified version from the specified application.
`DeleteConfigurationTemplateResult`	`deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)` Deletes the specified configuration template.
`DeleteEnvironmentConfigurationResult`	`deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)` Deletes the draft configuration associated with the running environment.
`DeletePlatformVersionResult`	`deletePlatformVersion(DeletePlatformVersionRequest request)` Deletes the specified version of a custom platform.
`DescribeApplicationsResult`	`describeApplications()` Simplified method form for invoking the DescribeApplications operation.
`DescribeApplicationsResult`	`describeApplications(DescribeApplicationsRequest request)` Returns the descriptions of existing applications.
`DescribeApplicationVersionsResult`	`describeApplicationVersions()` Simplified method form for invoking the DescribeApplicationVersions operation.
`DescribeApplicationVersionsResult`	`describeApplicationVersions(DescribeApplicationVersionsRequest request)` Retrieve a list of application versions.
`DescribeConfigurationOptionsResult`	`describeConfigurationOptions(DescribeConfigurationOptionsRequest request)` Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
`DescribeConfigurationSettingsResult`	`describeConfigurationSettings(DescribeConfigurationSettingsRequest request)` 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.
`DescribeEnvironmentHealthResult`	`describeEnvironmentHealth(DescribeEnvironmentHealthRequest request)` Returns information about the overall health of the specified environment.
`DescribeEnvironmentManagedActionHistoryResult`	`describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest request)` Lists an environment's completed and failed managed actions.
`DescribeEnvironmentManagedActionsResult`	`describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest request)` Lists an environment's upcoming and in-progress managed actions.
`DescribeEnvironmentResourcesResult`	`describeEnvironmentResources(DescribeEnvironmentResourcesRequest request)` Returns AWS resources for this environment.
`DescribeEnvironmentsResult`	`describeEnvironments()` Simplified method form for invoking the DescribeEnvironments operation.
`DescribeEnvironmentsResult`	`describeEnvironments(DescribeEnvironmentsRequest request)` Returns descriptions for existing environments.
`DescribeEventsResult`	`describeEvents()` Simplified method form for invoking the DescribeEvents operation.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns list of event descriptions matching criteria up to the last 6 weeks.
`DescribeInstancesHealthResult`	`describeInstancesHealth(DescribeInstancesHealthRequest request)` Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
`DescribePlatformVersionResult`	`describePlatformVersion(DescribePlatformVersionRequest request)` Describes the version of the platform.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAvailableSolutionStacksResult`	`listAvailableSolutionStacks()` Simplified method form for invoking the ListAvailableSolutionStacks operation.
`ListAvailableSolutionStacksResult`	`listAvailableSolutionStacks(ListAvailableSolutionStacksRequest request)` Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
`ListPlatformVersionsResult`	`listPlatformVersions(ListPlatformVersionsRequest request)` Lists the available platforms.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns the tags applied to an AWS Elastic Beanstalk resource.
`RebuildEnvironmentResult`	`rebuildEnvironment(RebuildEnvironmentRequest request)` 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.
`RequestEnvironmentInfoResult`	`requestEnvironmentInfo(RequestEnvironmentInfoRequest request)` Initiates a request to compile the specified type of information of the deployed environment.
`RestartAppServerResult`	`restartAppServer(RestartAppServerRequest request)` Causes the environment to restart the application container server running on each Amazon EC2 instance.
`RetrieveEnvironmentInfoResult`	`retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest request)` Retrieves the compiled information from a RequestEnvironmentInfo request.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSElasticBeanstalk.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SwapEnvironmentCNAMEsResult`	`swapEnvironmentCNAMEs()` Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
`SwapEnvironmentCNAMEsResult`	`swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest request)` Swaps the CNAMEs of two environments.
`TerminateEnvironmentResult`	`terminateEnvironment(TerminateEnvironmentRequest request)` Terminates the specified environment.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates the specified application to have the specified properties.
`UpdateApplicationResourceLifecycleResult`	`updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest request)` Modifies lifecycle settings for an application.
`UpdateApplicationVersionResult`	`updateApplicationVersion(UpdateApplicationVersionRequest request)` Updates the specified application version to have the specified properties.
`UpdateConfigurationTemplateResult`	`updateConfigurationTemplate(UpdateConfigurationTemplateRequest request)` Updates the specified configuration template to have the specified properties or configuration option values.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest request)` 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.
`UpdateTagsForResourceResult`	`updateTagsForResource(UpdateTagsForResourceRequest request)` Update the list of tags applied to an AWS Elastic Beanstalk resource.
`ValidateConfigurationSettingsResult`	`validateConfigurationSettings(ValidateConfigurationSettingsRequest request)` Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSElasticBeanstalk
    
    Parameters:
    
    endpoint - The endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSElasticBeanstalk
    
    An alternative to AWSElasticBeanstalk.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSElasticBeanstalk
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - abortEnvironmentUpdate
```
public AbortEnvironmentUpdateResult abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Cancels in-progress environment configuration update or application version deployment.
    
    Specified by:
    
    abortEnvironmentUpdate in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the AbortEnvironmentUpdate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - abortEnvironmentUpdate
```
public AbortEnvironmentUpdateResult abortEnvironmentUpdate()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the AbortEnvironmentUpdate operation.
    
    Specified by:
    
    abortEnvironmentUpdate in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)
  - applyEnvironmentManagedAction
```
public ApplyEnvironmentManagedActionResult applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    applyEnvironmentManagedAction in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to execute a scheduled managed action immediately.
    
    Returns:
    
    Result of the ApplyEnvironmentManagedAction operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - checkDNSAvailability
```
public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Checks if the specified CNAME is available.
    
    Specified by:
    
    checkDNSAvailability in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Results message indicating whether a CNAME is available.
    
    Returns:
    
    Result of the CheckDNSAvailability operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - composeEnvironments
```
public ComposeEnvironmentsResult composeEnvironments(ComposeEnvironmentsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    composeEnvironments in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to create or update a group of environments.
    
    Returns:
    
    Result of the ComposeEnvironments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Creates an application that has one configuration template named default and no application versions.
    
    Specified by:
    
    createApplication in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to create an application.
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createApplicationVersion
```
public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    createApplicationVersion in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the CreateApplicationVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConfigurationTemplate
```
public CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    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
    Specified by:
    
    createConfigurationTemplate in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to create a configuration template.
    
    Returns:
    
    Result of the CreateConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEnvironment
```
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Launches an environment for the specified application using the specified configuration.
    
    Specified by:
    
    createEnvironment in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPlatformVersion
```
public CreatePlatformVersionResult createPlatformVersion(CreatePlatformVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Create a new version of your custom platform.
    
    Specified by:
    
    createPlatformVersion in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to create a new platform version.
    
    Returns:
    
    Result of the CreatePlatformVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStorageLocation
```
public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Creates the Amazon S3 storage location for the account.
    
    This location is used to store user log files.
    
    Specified by:
    
    createStorageLocation in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the CreateStorageLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStorageLocation
```
public CreateStorageLocationResult createStorageLocation()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the CreateStorageLocation operation.
    
    Specified by:
    
    createStorageLocation in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.createStorageLocation(CreateStorageLocationRequest)
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    deleteApplication in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to delete an application.
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteApplicationVersion
```
public DeleteApplicationVersionResult deleteApplicationVersion(DeleteApplicationVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Deletes the specified version from the specified application.
    
    You cannot delete an application version that is associated with a running environment.
    
    Specified by:
    
    deleteApplicationVersion in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to delete an application version.
    
    Returns:
    
    Result of the DeleteApplicationVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConfigurationTemplate
```
public DeleteConfigurationTemplateResult deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    deleteConfigurationTemplate in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to delete a configuration template.
    
    Returns:
    
    Result of the DeleteConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironmentConfiguration
```
public DeleteEnvironmentConfigurationResult deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    deleteEnvironmentConfiguration in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to delete a draft environment configuration.
    
    Returns:
    
    Result of the DeleteEnvironmentConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePlatformVersion
```
public DeletePlatformVersionResult deletePlatformVersion(DeletePlatformVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Deletes the specified version of a custom platform.
    
    Specified by:
    
    deletePlatformVersion in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the DeletePlatformVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApplicationVersions
```
public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Retrieve a list of application versions.
    
    Specified by:
    
    describeApplicationVersions in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to describe application versions.
    
    Returns:
    
    Result of the DescribeApplicationVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApplicationVersions
```
public DescribeApplicationVersionsResult describeApplicationVersions()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeApplicationVersions operation.
    
    Specified by:
    
    describeApplicationVersions in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.describeApplicationVersions(DescribeApplicationVersionsRequest)
  - describeApplications
```
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns the descriptions of existing applications.
    
    Specified by:
    
    describeApplications in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to describe one or more applications.
    
    Returns:
    
    Result of the DescribeApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApplications
```
public DescribeApplicationsResult describeApplications()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeApplications operation.
    
    Specified by:
    
    describeApplications in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.describeApplications(DescribeApplicationsRequest)
  - describeConfigurationOptions
```
public DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    describeConfigurationOptions in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Result message containing a list of application version descriptions.
    
    Returns:
    
    Result of the DescribeConfigurationOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationSettings
```
public DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    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
    Specified by:
    
    describeConfigurationSettings in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Result message containing all of the configuration settings for a specified solution stack or configuration template.
    
    Returns:
    
    Result of the DescribeConfigurationSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentHealth
```
public DescribeEnvironmentHealthResult describeEnvironmentHealth(DescribeEnvironmentHealthRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
    
    Specified by:
    
    describeEnvironmentHealth in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - See the example below to learn how to create a request body.
    
    Returns:
    
    Result of the DescribeEnvironmentHealth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentManagedActionHistory
```
public DescribeEnvironmentManagedActionHistoryResult describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Lists an environment's completed and failed managed actions.
    
    Specified by:
    
    describeEnvironmentManagedActionHistory in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to list completed and failed managed actions.
    
    Returns:
    
    Result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentManagedActions
```
public DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Lists an environment's upcoming and in-progress managed actions.
    
    Specified by:
    
    describeEnvironmentManagedActions in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to list an environment's upcoming and in-progress managed actions.
    
    Returns:
    
    Result of the DescribeEnvironmentManagedActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentResources
```
public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns AWS resources for this environment.
    
    Specified by:
    
    describeEnvironmentResources in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to describe the resources in an environment.
    
    Returns:
    
    Result of the DescribeEnvironmentResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironments
```
public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns descriptions for existing environments.
    
    Specified by:
    
    describeEnvironments in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to describe one or more environments.
    
    Returns:
    
    Result of the DescribeEnvironments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironments
```
public DescribeEnvironmentsResult describeEnvironments()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeEnvironments operation.
    
    Specified by:
    
    describeEnvironments in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    describeEvents in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to retrieve a list of events for an environment.
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeEvents operation.
    
    Specified by:
    
    describeEvents in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.describeEvents(DescribeEventsRequest)
  - describeInstancesHealth
```
public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
    
    Specified by:
    
    describeInstancesHealth in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Parameters for a call to DescribeInstancesHealth.
    
    Returns:
    
    Result of the DescribeInstancesHealth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePlatformVersion
```
public DescribePlatformVersionResult describePlatformVersion(DescribePlatformVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Describes the version of the platform.
    
    Specified by:
    
    describePlatformVersion in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the DescribePlatformVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAvailableSolutionStacks
```
public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
    
    Specified by:
    
    listAvailableSolutionStacks in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the ListAvailableSolutionStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAvailableSolutionStacks
```
public ListAvailableSolutionStacksResult listAvailableSolutionStacks()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the ListAvailableSolutionStacks operation.
    
    Specified by:
    
    listAvailableSolutionStacks in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)
  - listPlatformVersions
```
public ListPlatformVersionsResult listPlatformVersions(ListPlatformVersionsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Lists the available platforms.
    
    Specified by:
    
    listPlatformVersions in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the ListPlatformVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
    
    Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.
    
    Specified by:
    
    listTagsForResource in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebuildEnvironment
```
public RebuildEnvironmentResult rebuildEnvironment(RebuildEnvironmentRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    rebuildEnvironment in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the RebuildEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - requestEnvironmentInfo
```
public RequestEnvironmentInfoResult requestEnvironmentInfo(RequestEnvironmentInfoRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    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
    Specified by:
    
    requestEnvironmentInfo in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
    
    Returns:
    
    Result of the RequestEnvironmentInfo operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restartAppServer
```
public RestartAppServerResult restartAppServer(RestartAppServerRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Causes the environment to restart the application container server running on each Amazon EC2 instance.
    
    Specified by:
    
    restartAppServer in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the RestartAppServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - retrieveEnvironmentInfo
```
public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    Retrieves the compiled information from a RequestEnvironmentInfo request.
    
    Related Topics
    - RequestEnvironmentInfo
    Specified by:
    
    retrieveEnvironmentInfo in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to download logs retrieved with RequestEnvironmentInfo.
    
    Returns:
    
    Result of the RetrieveEnvironmentInfo operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - swapEnvironmentCNAMEs
```
public SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Swaps the CNAMEs of two environments.
    
    Specified by:
    
    swapEnvironmentCNAMEs in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Swaps the CNAMEs of two environments.
    
    Returns:
    
    Result of the SwapEnvironmentCNAMEs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - swapEnvironmentCNAMEs
```
public SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
    
    Specified by:
    
    swapEnvironmentCNAMEs in interface AWSElasticBeanstalk
    
    See Also:
    
    AWSElasticBeanstalk.swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)
  - terminateEnvironment
```
public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Terminates the specified environment.
    
    Specified by:
    
    terminateEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to terminate an environment.
    
    Returns:
    
    Result of the TerminateEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    updateApplication in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to update an application.
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplicationResourceLifecycle
```
public UpdateApplicationResourceLifecycleResult updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Modifies lifecycle settings for an application.
    
    Specified by:
    
    updateApplicationResourceLifecycle in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the UpdateApplicationResourceLifecycle operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApplicationVersion
```
public UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    updateApplicationVersion in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the UpdateApplicationVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConfigurationTemplate
```
public UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    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
    Specified by:
    
    updateConfigurationTemplate in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - The result message containing the options for the specified solution stack.
    
    Returns:
    
    Result of the UpdateConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    updateEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - Request to update an environment.
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTagsForResource
```
public UpdateTagsForResourceResult updateTagsForResource(UpdateTagsForResourceRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.
    
    Specified by:
    
    updateTagsForResource in interface AWSElasticBeanstalk
    
    Returns:
    
    Result of the UpdateTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - validateConfigurationSettings
```
public ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    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.
    
    Specified by:
    
    validateConfigurationSettings in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - A list of validation messages for a specified configuration template.
    
    Returns:
    
    Result of the ValidateConfigurationSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSElasticBeanstalk
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSElasticBeanstalk
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSElasticBeanstalk
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSElasticBeanstalk

Field Summary

Fields inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

abortEnvironmentUpdate

abortEnvironmentUpdate

applyEnvironmentManagedAction

checkDNSAvailability

composeEnvironments

createApplication

createApplicationVersion

createConfigurationTemplate

createEnvironment

createPlatformVersion

createStorageLocation

createStorageLocation

deleteApplication

deleteApplicationVersion

deleteConfigurationTemplate

deleteEnvironmentConfiguration

deletePlatformVersion

describeApplicationVersions

describeApplicationVersions

describeApplications

describeApplications

describeConfigurationOptions

describeConfigurationSettings

describeEnvironmentHealth

describeEnvironmentManagedActionHistory

describeEnvironmentManagedActions

describeEnvironmentResources

describeEnvironments

describeEnvironments

describeEvents

describeEvents

describeInstancesHealth

describePlatformVersion

listAvailableSolutionStacks

listAvailableSolutionStacks

listPlatformVersions

listTagsForResource

rebuildEnvironment

requestEnvironmentInfo

restartAppServer

retrieveEnvironmentInfo

swapEnvironmentCNAMEs

swapEnvironmentCNAMEs

terminateEnvironment

updateApplication

updateApplicationResourceLifecycle

updateApplicationVersion

updateConfigurationTemplate

updateEnvironment

updateTagsForResource

validateConfigurationSettings

shutdown

getCachedResponseMetadata