public class AbstractAWSElasticBeanstalk extends Object implements AWSElasticBeanstalk
AWSElasticBeanstalk. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
void |
abortEnvironmentUpdate()
Simplified method form for invoking the AbortEnvironmentUpdate operation.
|
void |
abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)
Cancels in-progress environment configuration update or application
version deployment.
|
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.
|
CreateStorageLocationResult |
createStorageLocation()
Simplified method form for invoking the CreateStorageLocation operation.
|
CreateStorageLocationResult |
createStorageLocation(CreateStorageLocationRequest request)
Creates the Amazon S3 storage location for the account.
|
void |
deleteApplication(DeleteApplicationRequest request)
Deletes the specified application along with all associated versions and
configurations.
|
void |
deleteApplicationVersion(DeleteApplicationVersionRequest request)
Deletes the specified version from the specified application.
|
void |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)
Deletes the specified configuration template.
|
void |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)
Deletes the draft configuration associated with the running environment.
|
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 stored in your AWS Elastic
Beanstalk storage bucket.
|
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.
|
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)
Returns more detailed information about the health of the specified
instances (for example, CPU utilization, load average, and causes).
|
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.
|
void |
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.
|
void |
requestEnvironmentInfo(RequestEnvironmentInfoRequest request)
Initiates a request to compile the specified type of information of the
deployed environment.
|
void |
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.
|
void |
swapEnvironmentCNAMEs()
Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
|
void |
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.
|
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.
|
ValidateConfigurationSettingsResult |
validateConfigurationSettings(ValidateConfigurationSettingsRequest request)
Takes a set of configuration settings and either a configuration template
or environment, and determines whether those values are valid.
|
public void setEndpoint(String endpoint)
AWSElasticBeanstalk
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.
setEndpoint in interface AWSElasticBeanstalkendpoint - 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.public void setRegion(Region region)
AWSElasticBeanstalkAWSElasticBeanstalk.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.
setRegion in interface AWSElasticBeanstalkregion - 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public void abortEnvironmentUpdate(AbortEnvironmentUpdateRequest request)
AWSElasticBeanstalkCancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdate in interface AWSElasticBeanstalkpublic void abortEnvironmentUpdate()
AWSElasticBeanstalkabortEnvironmentUpdate in interface AWSElasticBeanstalkAWSElasticBeanstalk.abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest request)
AWSElasticBeanstalkChecks if the specified CNAME is available.
checkDNSAvailability in interface AWSElasticBeanstalkrequest - Results message indicating whether a CNAME is available.public ComposeEnvironmentsResult composeEnvironments(ComposeEnvironmentsRequest request)
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.
composeEnvironments in interface AWSElasticBeanstalkpublic CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSElasticBeanstalk
Creates an application that has one configuration template named
default and no application versions.
createApplication in interface AWSElasticBeanstalkpublic CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest request)
AWSElasticBeanstalkCreates an application version for the specified application.
createApplicationVersion in interface AWSElasticBeanstalkpublic CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest request)
AWSElasticBeanstalkCreates 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
createConfigurationTemplate in interface AWSElasticBeanstalkpublic CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSElasticBeanstalkLaunches an environment for the specified application using the specified configuration.
createEnvironment in interface AWSElasticBeanstalkpublic CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest request)
AWSElasticBeanstalkCreates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocation in interface AWSElasticBeanstalkpublic CreateStorageLocationResult createStorageLocation()
AWSElasticBeanstalkcreateStorageLocation in interface AWSElasticBeanstalkAWSElasticBeanstalk.createStorageLocation(CreateStorageLocationRequest)public void deleteApplication(DeleteApplicationRequest request)
AWSElasticBeanstalkDeletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
deleteApplication in interface AWSElasticBeanstalkpublic void deleteApplicationVersion(DeleteApplicationVersionRequest request)
AWSElasticBeanstalkDeletes the specified version from the specified application.
deleteApplicationVersion in interface AWSElasticBeanstalkpublic void deleteConfigurationTemplate(DeleteConfigurationTemplateRequest request)
AWSElasticBeanstalkDeletes the specified configuration template.
deleteConfigurationTemplate in interface AWSElasticBeanstalkpublic void deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest request)
AWSElasticBeanstalkDeletes 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.
deleteEnvironmentConfiguration in interface AWSElasticBeanstalkpublic DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest request)
AWSElasticBeanstalkRetrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
describeApplicationVersions in interface AWSElasticBeanstalkrequest - Result message containing a list of configuration descriptions.public DescribeApplicationVersionsResult describeApplicationVersions()
AWSElasticBeanstalkdescribeApplicationVersions in interface AWSElasticBeanstalkAWSElasticBeanstalk.describeApplicationVersions(DescribeApplicationVersionsRequest)public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
AWSElasticBeanstalkReturns the descriptions of existing applications.
describeApplications in interface AWSElasticBeanstalkpublic DescribeApplicationsResult describeApplications()
AWSElasticBeanstalkdescribeApplications in interface AWSElasticBeanstalkAWSElasticBeanstalk.describeApplications(DescribeApplicationsRequest)public DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest request)
AWSElasticBeanstalkDescribes 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.
describeConfigurationOptions in interface AWSElasticBeanstalkrequest - Result message containig a list of application version
descriptions.public DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest request)
AWSElasticBeanstalkReturns 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
describeConfigurationSettings in interface AWSElasticBeanstalkrequest - Result message containing all of the configuration settings for a
specified solution stack or configuration template.public DescribeEnvironmentHealthResult describeEnvironmentHealth(DescribeEnvironmentHealthRequest request)
AWSElasticBeanstalkReturns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeEnvironmentHealth in interface AWSElasticBeanstalkrequest - See the example below to learn how to create a request body.public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest request)
AWSElasticBeanstalkReturns AWS resources for this environment.
describeEnvironmentResources in interface AWSElasticBeanstalkpublic DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest request)
AWSElasticBeanstalkReturns descriptions for existing environments.
describeEnvironments in interface AWSElasticBeanstalkpublic DescribeEnvironmentsResult describeEnvironments()
AWSElasticBeanstalkdescribeEnvironments in interface AWSElasticBeanstalkAWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AWSElasticBeanstalkReturns list of event descriptions matching criteria up to the last 6 weeks.
NextToken. describeEvents in interface AWSElasticBeanstalkpublic DescribeEventsResult describeEvents()
AWSElasticBeanstalkdescribeEvents in interface AWSElasticBeanstalkAWSElasticBeanstalk.describeEvents(DescribeEventsRequest)public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest request)
AWSElasticBeanstalkReturns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeInstancesHealth in interface AWSElasticBeanstalkrequest - See the example below to learn how to create a request body.public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest request)
AWSElasticBeanstalkReturns a list of the available solution stack names.
listAvailableSolutionStacks in interface AWSElasticBeanstalkpublic ListAvailableSolutionStacksResult listAvailableSolutionStacks()
AWSElasticBeanstalklistAvailableSolutionStacks in interface AWSElasticBeanstalkAWSElasticBeanstalk.listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)public void rebuildEnvironment(RebuildEnvironmentRequest request)
AWSElasticBeanstalkDeletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
rebuildEnvironment in interface AWSElasticBeanstalkpublic void requestEnvironmentInfo(RequestEnvironmentInfoRequest request)
AWSElasticBeanstalkInitiates 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
requestEnvironmentInfo in interface AWSElasticBeanstalkpublic void restartAppServer(RestartAppServerRequest request)
AWSElasticBeanstalkCauses the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServer in interface AWSElasticBeanstalkpublic RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest request)
AWSElasticBeanstalkRetrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfo in interface AWSElasticBeanstalkpublic void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest request)
AWSElasticBeanstalkSwaps the CNAMEs of two environments.
swapEnvironmentCNAMEs in interface AWSElasticBeanstalkrequest - Swaps the CNAMEs of two environments.public void swapEnvironmentCNAMEs()
AWSElasticBeanstalkswapEnvironmentCNAMEs in interface AWSElasticBeanstalkAWSElasticBeanstalk.swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest request)
AWSElasticBeanstalkTerminates the specified environment.
terminateEnvironment in interface AWSElasticBeanstalkpublic UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSElasticBeanstalkUpdates the specified application to have the specified properties.
description) is not
provided, the value remains unchanged. To clear these properties, specify
an empty string. updateApplication in interface AWSElasticBeanstalkpublic UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest request)
AWSElasticBeanstalkUpdates the specified application version to have the specified properties.
description) is not
provided, the value remains unchanged. To clear properties, specify an
empty string. updateApplicationVersion in interface AWSElasticBeanstalkpublic UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest request)
AWSElasticBeanstalkUpdates 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
updateConfigurationTemplate in interface AWSElasticBeanstalkrequest - The result message containing the options for the specified
solution stack.public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AWSElasticBeanstalkUpdates 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.
updateEnvironment in interface AWSElasticBeanstalkpublic ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest request)
AWSElasticBeanstalkTakes 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.
validateConfigurationSettings in interface AWSElasticBeanstalkrequest - A list of validation messages for a specified configuration
template.public void shutdown()
AWSElasticBeanstalkshutdown in interface AWSElasticBeanstalkpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSElasticBeanstalkResponse 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.
getCachedResponseMetadata in interface AWSElasticBeanstalkrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.